FHIR Artifacts > Structure Definition: HealthcareService Profile
Structure Definition: HealthcareService Profile
Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-HealthcareService
Simplifier project page: HealthcareService
Derived from: HealthcareService (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
HealthcareService | I | HealthcareService | There are no (further) constraints on this element Element IdHealthcareService The details of a healthcare service available at a location DefinitionThe details of a healthcare service available at a location.
| |
meta | S Σ | 1..1 | Meta | There are no (further) constraints on this element Element IdHealthcareService.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdHealthcareService.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdHealthcareService.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | Element IdHealthcareService.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
|
security | Σ | 0..* | CodingBinding | Element IdHealthcareService.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. SecurityLabels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
text | S | 0..1 | Narrative | There are no (further) constraints on this element Element IdHealthcareService.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
|
extension | I | 0..* | Extension | Element IdHealthcareService.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
UsageLicense | I | 0..1 | Extension(url) | Element IdHealthcareService.extension:UsageLicense Optional Extensions Element Alternate namesextensions, user content DefinitionExtension to describe the licensing conditions under which this HealthcareService (and related) resources may be used. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-usage-license Constraints
|
Media | I | 0..* | Extension(Attachment) | Element IdHealthcareService.extension:Media Optional Extensions Element Alternate namesextensions, user content DefinitionExtension to capture photos, documents and files that relate to a HealthcareService. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-media Constraints
|
AccessInstructions | I | 0..1 | Extension(markdown) | Element IdHealthcareService.extension:AccessInstructions Optional Extensions Element Alternate namesextensions, user content DefinitionExtension describes how a person gets started with this HealthcareService. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-access-instructions Constraints
|
DeliveryMethod | I | 0..* | Extension(code) | Element IdHealthcareService.extension:DeliveryMethod Optional Extensions Element Alternate namesextensions, user content DefinitionExtension to describe how the service is delivered to the client. Usually there is only one deliveryMethod, but in some case there are multiple (e.g., On “site” counseling with a “video-call” option.) There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-delivery-method Constraints
|
identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdHealthcareService.identifier External identifiers for this item DefinitionExternal identifiers for this item.
|
use | Σ ?! | 0..1 | codeBinding | Element IdHealthcareService.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | S Σ | 0..1 | CodeableConceptBinding | Element IdHealthcareService.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierType (extensible)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | S Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdHealthcareService.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
active | Σ ?! | 1..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.active Whether this HealthcareService record is in active use DefinitionThis flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. This element is labeled as a modifier because it may be used to mark that the resource was created in error.
|
providedBy | S Σ I | 0..1 | Reference(Organization) | Element IdHealthcareService.providedBy Organization that provides this service DefinitionThe organization that provides this healthcare service. This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.providedBy.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdHealthcareService.providedBy.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdHealthcareService.providedBy.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdHealthcareService.providedBy.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
category | Σ | 0..* | CodeableConceptBinding | Element IdHealthcareService.category Broad category of service being performed or delivered Alternate namesservice category DefinitionIdentifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. The high level healthcare sector of the listing. (e.g., Mental health service, Community health services, Laboratory service, etc) A category of the service(s) that could be provided. HealthcareServiceCategories (extensible)Constraints
|
type | S Σ | 0..* | CodeableConceptBinding | Element IdHealthcareService.type Type of service that may be delivered or performed Alternate namesservice type DefinitionThe specific type of service that may be delivered or performed. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient. PractitionerSpecialty (preferred)Constraints
|
extension | I | 0..* | Extension | Element IdHealthcareService.type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
PrimaryType | I | 0..1 | Extension(boolean) | Element IdHealthcareService.type.extension:PrimaryType Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-primary-type Constraints
|
Facet | S I | 0..* | Extension(CodeableConcept) | Element IdHealthcareService.type.extension:Facet Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-facet Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdHealthcareService.type.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdHealthcareService.specialty Specialties handled by the HealthcareService DefinitionCollection of specialties handled by the service site. This is more of a medical term. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A specialty that a healthcare service may provide. PracticeSettingCodeValueSet (preferred)Constraints
|
location | S Σ I | 0..* | Reference(Location) | Element IdHealthcareService.location Location(s) where service may be provided DefinitionThe location(s) where this healthcare service may be provided. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
reference | S Σ I | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.location.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdHealthcareService.location.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdHealthcareService.location.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.location.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
name | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.name Description of service as presented to a consumer while searching DefinitionFurther description of the service as it would be presented to a consumer while searching. Note that FHIR strings SHALL NOT exceed 1MB in size
|
comment | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.comment Additional description and/or any specific issues not covered elsewhere DefinitionAny additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.
|
extraDetails | S | 0..1 | markdown | There are no (further) constraints on this element Element IdHealthcareService.extraDetails Extra details about the service that can't be placed in the other fields DefinitionExtra details about the service that can't be placed in the other fields. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
|
photo | Σ I | 0..1 | Attachment | There are no (further) constraints on this element Element IdHealthcareService.photo Facilitates quick identification of the service DefinitionIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
telecom | S I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdHealthcareService.telecom Contacts related to the healthcare service DefinitionList of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts.
|
system | S Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdHealthcareService.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
start | S Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdHealthcareService.telecom.period.start Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known.
|
end | S Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdHealthcareService.telecom.period.end End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
|
coverageArea | I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdHealthcareService.coverageArea Location(s) service is intended for/available to DefinitionThe location(s) that this service is available to (not where the service is provided). The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".
|
serviceProvisionCode | 0..* | CodeableConceptBinding | Element IdHealthcareService.serviceProvisionCode Conditions under which service is available/offered DefinitionThe code(s) that detail the conditions under which the healthcare service is available/offered. The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply. The code(s) that detail the conditions under which the healthcare service is available/offered. ServiceProvisionConditions (extensible)Constraints
| |
eligibility | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.eligibility Specific eligibility requirements required to use the service DefinitionDoes this service have specific eligibility requirements that need to be met in order to use the service?
| |
code | S | 0..1 | CodeableConceptBinding | Element IdHealthcareService.eligibility.code Coded value for the eligibility DefinitionCoded value for the eligibility. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Coded values underwhich a specific service is made available. EligibilityCriteria (extensible)Constraints
|
comment | 0..1 | markdown | There are no (further) constraints on this element Element IdHealthcareService.eligibility.comment Describes the eligibility conditions for the service DefinitionDescribes the eligibility conditions for the service. The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.
| |
program | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.program Programs that this service is applicable to DefinitionPrograms that this service is applicable to. Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. Government or local programs that this service applies to. Program (example)Constraints
| |
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.program.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.program.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.program.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdHealthcareService.program.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.program.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.program.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.program.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
characteristic | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.characteristic Collection of characteristics (attributes) DefinitionCollection of characteristics (attributes). These could be such things as is wheelchair accessible. A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). (unbound) (example)Constraints
| |
extension | I | 0..* | Extension | Element IdHealthcareService.characteristic.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
Facet | I | 0..* | Extension(CodeableConcept) | Element IdHealthcareService.characteristic.extension:Facet Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-facet Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdHealthcareService.characteristic.extension:Facet.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://ehealthontario.ca/fhir/StructureDefinition/ext-facet
| |
value[x] | S | 0..1 | Binding | There are no (further) constraints on this element Element IdHealthcareService.characteristic.extension:Facet.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). Codes representing semantic categories in a faceted taxonomy system. Facet (extensible)Constraints
|
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.characteristic.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.characteristic.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
communication | 0..* | CodeableConceptBinding | Element IdHealthcareService.communication The language that this service is offered in DefinitionSome services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling. Languages understood or supported by Ontario clients and organizations. This value set represents the subset of all ISO living languages as of April 22, 2020. Language (preferred)Constraints
| |
referralMethod | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.referralMethod Ways that the service accepts referrals DefinitionWays that the service accepts referrals, if this is not provided then it is implied that no referral is required. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The methods of referral can be used when referring to a specific HealthCareService resource. ReferralMethod (example)Constraints
| |
appointmentRequired | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.appointmentRequired If an appointment is required for access to this service DefinitionIndicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
| |
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.availableTime Times the Service Site is available DefinitionA collection of times that the Service Site is available. More detailed availability information may be provided in associated Schedule/Slot resources.
| |
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdHealthcareService.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The time zone is expected to be for where this HealthcareService is provided at.
| |
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdHealthcareService.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The time zone is expected to be for where this HealthcareService is provided at.
| |
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.notAvailable Not available during this time due to provided reason DefinitionThe HealthcareService is not available during this period of time due to the provided reason.
| |
description | 1..1 | string | There are no (further) constraints on this element Element IdHealthcareService.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
during | I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.availabilityExceptions Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | S I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdHealthcareService.endpoint Technical endpoints providing access to electronic services operated for the healthcare service DefinitionTechnical endpoints providing access to services operated for the specific healthcare services defined at this resource. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
reference | S Σ I | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.endpoint.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | S Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdHealthcareService.endpoint.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdHealthcareService.endpoint.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.endpoint.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
Hybrid View
HealthcareService | I | HealthcareService | There are no (further) constraints on this element Element IdHealthcareService The details of a healthcare service available at a location DefinitionThe details of a healthcare service available at a location.
| |
meta | S Σ | 1..1 | Meta | There are no (further) constraints on this element Element IdHealthcareService.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdHealthcareService.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdHealthcareService.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | Element IdHealthcareService.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
|
security | Σ | 0..* | CodingBinding | Element IdHealthcareService.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. SecurityLabels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
text | S | 0..1 | Narrative | There are no (further) constraints on this element Element IdHealthcareService.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
|
extension | I | 0..* | Extension | Element IdHealthcareService.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
UsageLicense | I | 0..1 | Extension(url) | Element IdHealthcareService.extension:UsageLicense Optional Extensions Element Alternate namesextensions, user content DefinitionExtension to describe the licensing conditions under which this HealthcareService (and related) resources may be used. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-usage-license Constraints
|
Media | I | 0..* | Extension(Attachment) | Element IdHealthcareService.extension:Media Optional Extensions Element Alternate namesextensions, user content DefinitionExtension to capture photos, documents and files that relate to a HealthcareService. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-media Constraints
|
AccessInstructions | I | 0..1 | Extension(markdown) | Element IdHealthcareService.extension:AccessInstructions Optional Extensions Element Alternate namesextensions, user content DefinitionExtension describes how a person gets started with this HealthcareService. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-access-instructions Constraints
|
DeliveryMethod | I | 0..* | Extension(code) | Element IdHealthcareService.extension:DeliveryMethod Optional Extensions Element Alternate namesextensions, user content DefinitionExtension to describe how the service is delivered to the client. Usually there is only one deliveryMethod, but in some case there are multiple (e.g., On “site” counseling with a “video-call” option.) There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-delivery-method Constraints
|
identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdHealthcareService.identifier External identifiers for this item DefinitionExternal identifiers for this item.
|
use | Σ ?! | 0..1 | codeBinding | Element IdHealthcareService.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | S Σ | 0..1 | CodeableConceptBinding | Element IdHealthcareService.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierType (extensible)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | S Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdHealthcareService.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
active | Σ ?! | 1..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.active Whether this HealthcareService record is in active use DefinitionThis flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. This element is labeled as a modifier because it may be used to mark that the resource was created in error.
|
providedBy | S Σ I | 0..1 | Reference(Organization) | Element IdHealthcareService.providedBy Organization that provides this service DefinitionThe organization that provides this healthcare service. This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.providedBy.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdHealthcareService.providedBy.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdHealthcareService.providedBy.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdHealthcareService.providedBy.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
category | Σ | 0..* | CodeableConceptBinding | Element IdHealthcareService.category Broad category of service being performed or delivered Alternate namesservice category DefinitionIdentifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. The high level healthcare sector of the listing. (e.g., Mental health service, Community health services, Laboratory service, etc) A category of the service(s) that could be provided. HealthcareServiceCategories (extensible)Constraints
|
type | S Σ | 0..* | CodeableConceptBinding | Element IdHealthcareService.type Type of service that may be delivered or performed Alternate namesservice type DefinitionThe specific type of service that may be delivered or performed. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient. PractitionerSpecialty (preferred)Constraints
|
extension | I | 0..* | Extension | Element IdHealthcareService.type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
PrimaryType | I | 0..1 | Extension(boolean) | Element IdHealthcareService.type.extension:PrimaryType Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-primary-type Constraints
|
Facet | S I | 0..* | Extension(CodeableConcept) | Element IdHealthcareService.type.extension:Facet Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-facet Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdHealthcareService.type.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdHealthcareService.specialty Specialties handled by the HealthcareService DefinitionCollection of specialties handled by the service site. This is more of a medical term. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A specialty that a healthcare service may provide. PracticeSettingCodeValueSet (preferred)Constraints
|
location | S Σ I | 0..* | Reference(Location) | Element IdHealthcareService.location Location(s) where service may be provided DefinitionThe location(s) where this healthcare service may be provided. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
reference | S Σ I | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.location.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdHealthcareService.location.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdHealthcareService.location.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.location.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
name | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.name Description of service as presented to a consumer while searching DefinitionFurther description of the service as it would be presented to a consumer while searching. Note that FHIR strings SHALL NOT exceed 1MB in size
|
comment | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.comment Additional description and/or any specific issues not covered elsewhere DefinitionAny additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.
|
extraDetails | S | 0..1 | markdown | There are no (further) constraints on this element Element IdHealthcareService.extraDetails Extra details about the service that can't be placed in the other fields DefinitionExtra details about the service that can't be placed in the other fields. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
|
photo | Σ I | 0..1 | Attachment | There are no (further) constraints on this element Element IdHealthcareService.photo Facilitates quick identification of the service DefinitionIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
telecom | S I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdHealthcareService.telecom Contacts related to the healthcare service DefinitionList of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts.
|
system | S Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdHealthcareService.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
start | S Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdHealthcareService.telecom.period.start Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known.
|
end | S Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdHealthcareService.telecom.period.end End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
|
coverageArea | I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdHealthcareService.coverageArea Location(s) service is intended for/available to DefinitionThe location(s) that this service is available to (not where the service is provided). The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".
|
serviceProvisionCode | 0..* | CodeableConceptBinding | Element IdHealthcareService.serviceProvisionCode Conditions under which service is available/offered DefinitionThe code(s) that detail the conditions under which the healthcare service is available/offered. The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply. The code(s) that detail the conditions under which the healthcare service is available/offered. ServiceProvisionConditions (extensible)Constraints
| |
eligibility | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.eligibility Specific eligibility requirements required to use the service DefinitionDoes this service have specific eligibility requirements that need to be met in order to use the service?
| |
code | S | 0..1 | CodeableConceptBinding | Element IdHealthcareService.eligibility.code Coded value for the eligibility DefinitionCoded value for the eligibility. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Coded values underwhich a specific service is made available. EligibilityCriteria (extensible)Constraints
|
comment | 0..1 | markdown | There are no (further) constraints on this element Element IdHealthcareService.eligibility.comment Describes the eligibility conditions for the service DefinitionDescribes the eligibility conditions for the service. The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.
| |
program | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.program Programs that this service is applicable to DefinitionPrograms that this service is applicable to. Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. Government or local programs that this service applies to. Program (example)Constraints
| |
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.program.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.program.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.program.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdHealthcareService.program.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.program.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.program.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.program.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
characteristic | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.characteristic Collection of characteristics (attributes) DefinitionCollection of characteristics (attributes). These could be such things as is wheelchair accessible. A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). (unbound) (example)Constraints
| |
extension | I | 0..* | Extension | Element IdHealthcareService.characteristic.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
Facet | I | 0..* | Extension(CodeableConcept) | Element IdHealthcareService.characteristic.extension:Facet Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-facet Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdHealthcareService.characteristic.extension:Facet.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://ehealthontario.ca/fhir/StructureDefinition/ext-facet
| |
value[x] | S | 0..1 | Binding | There are no (further) constraints on this element Element IdHealthcareService.characteristic.extension:Facet.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). Codes representing semantic categories in a faceted taxonomy system. Facet (extensible)Constraints
|
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.characteristic.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.characteristic.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
communication | 0..* | CodeableConceptBinding | Element IdHealthcareService.communication The language that this service is offered in DefinitionSome services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling. Languages understood or supported by Ontario clients and organizations. This value set represents the subset of all ISO living languages as of April 22, 2020. Language (preferred)Constraints
| |
referralMethod | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.referralMethod Ways that the service accepts referrals DefinitionWays that the service accepts referrals, if this is not provided then it is implied that no referral is required. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The methods of referral can be used when referring to a specific HealthCareService resource. ReferralMethod (example)Constraints
| |
appointmentRequired | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.appointmentRequired If an appointment is required for access to this service DefinitionIndicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
| |
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.availableTime Times the Service Site is available DefinitionA collection of times that the Service Site is available. More detailed availability information may be provided in associated Schedule/Slot resources.
| |
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdHealthcareService.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The time zone is expected to be for where this HealthcareService is provided at.
| |
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdHealthcareService.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The time zone is expected to be for where this HealthcareService is provided at.
| |
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.notAvailable Not available during this time due to provided reason DefinitionThe HealthcareService is not available during this period of time due to the provided reason.
| |
description | 1..1 | string | There are no (further) constraints on this element Element IdHealthcareService.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
during | I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.availabilityExceptions Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | S I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdHealthcareService.endpoint Technical endpoints providing access to electronic services operated for the healthcare service DefinitionTechnical endpoints providing access to services operated for the specific healthcare services defined at this resource. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
reference | S Σ I | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.endpoint.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | S Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdHealthcareService.endpoint.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdHealthcareService.endpoint.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.endpoint.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
Snapshot View
HealthcareService | I | HealthcareService | There are no (further) constraints on this element Element IdHealthcareService The details of a healthcare service available at a location DefinitionThe details of a healthcare service available at a location.
| |
meta | S Σ | 1..1 | Meta | There are no (further) constraints on this element Element IdHealthcareService.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdHealthcareService.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdHealthcareService.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | Element IdHealthcareService.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
|
security | Σ | 0..* | CodingBinding | Element IdHealthcareService.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. SecurityLabels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
text | S | 0..1 | Narrative | There are no (further) constraints on this element Element IdHealthcareService.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
|
extension | I | 0..* | Extension | Element IdHealthcareService.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
UsageLicense | I | 0..1 | Extension(url) | Element IdHealthcareService.extension:UsageLicense Optional Extensions Element Alternate namesextensions, user content DefinitionExtension to describe the licensing conditions under which this HealthcareService (and related) resources may be used. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-usage-license Constraints
|
Media | I | 0..* | Extension(Attachment) | Element IdHealthcareService.extension:Media Optional Extensions Element Alternate namesextensions, user content DefinitionExtension to capture photos, documents and files that relate to a HealthcareService. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-media Constraints
|
AccessInstructions | I | 0..1 | Extension(markdown) | Element IdHealthcareService.extension:AccessInstructions Optional Extensions Element Alternate namesextensions, user content DefinitionExtension describes how a person gets started with this HealthcareService. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-access-instructions Constraints
|
DeliveryMethod | I | 0..* | Extension(code) | Element IdHealthcareService.extension:DeliveryMethod Optional Extensions Element Alternate namesextensions, user content DefinitionExtension to describe how the service is delivered to the client. Usually there is only one deliveryMethod, but in some case there are multiple (e.g., On “site” counseling with a “video-call” option.) There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-delivery-method Constraints
|
identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdHealthcareService.identifier External identifiers for this item DefinitionExternal identifiers for this item.
|
use | Σ ?! | 0..1 | codeBinding | Element IdHealthcareService.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | S Σ | 0..1 | CodeableConceptBinding | Element IdHealthcareService.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierType (extensible)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | S Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdHealthcareService.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
active | Σ ?! | 1..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.active Whether this HealthcareService record is in active use DefinitionThis flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. This element is labeled as a modifier because it may be used to mark that the resource was created in error.
|
providedBy | S Σ I | 0..1 | Reference(Organization) | Element IdHealthcareService.providedBy Organization that provides this service DefinitionThe organization that provides this healthcare service. This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.providedBy.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdHealthcareService.providedBy.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdHealthcareService.providedBy.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdHealthcareService.providedBy.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
category | Σ | 0..* | CodeableConceptBinding | Element IdHealthcareService.category Broad category of service being performed or delivered Alternate namesservice category DefinitionIdentifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. The high level healthcare sector of the listing. (e.g., Mental health service, Community health services, Laboratory service, etc) A category of the service(s) that could be provided. HealthcareServiceCategories (extensible)Constraints
|
type | S Σ | 0..* | CodeableConceptBinding | Element IdHealthcareService.type Type of service that may be delivered or performed Alternate namesservice type DefinitionThe specific type of service that may be delivered or performed. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient. PractitionerSpecialty (preferred)Constraints
|
extension | I | 0..* | Extension | Element IdHealthcareService.type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
PrimaryType | I | 0..1 | Extension(boolean) | Element IdHealthcareService.type.extension:PrimaryType Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-primary-type Constraints
|
Facet | S I | 0..* | Extension(CodeableConcept) | Element IdHealthcareService.type.extension:Facet Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-facet Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdHealthcareService.type.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdHealthcareService.specialty Specialties handled by the HealthcareService DefinitionCollection of specialties handled by the service site. This is more of a medical term. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A specialty that a healthcare service may provide. PracticeSettingCodeValueSet (preferred)Constraints
|
location | S Σ I | 0..* | Reference(Location) | Element IdHealthcareService.location Location(s) where service may be provided DefinitionThe location(s) where this healthcare service may be provided. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
reference | S Σ I | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.location.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdHealthcareService.location.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdHealthcareService.location.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.location.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
name | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.name Description of service as presented to a consumer while searching DefinitionFurther description of the service as it would be presented to a consumer while searching. Note that FHIR strings SHALL NOT exceed 1MB in size
|
comment | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.comment Additional description and/or any specific issues not covered elsewhere DefinitionAny additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.
|
extraDetails | S | 0..1 | markdown | There are no (further) constraints on this element Element IdHealthcareService.extraDetails Extra details about the service that can't be placed in the other fields DefinitionExtra details about the service that can't be placed in the other fields. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
|
photo | Σ I | 0..1 | Attachment | There are no (further) constraints on this element Element IdHealthcareService.photo Facilitates quick identification of the service DefinitionIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
telecom | S I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdHealthcareService.telecom Contacts related to the healthcare service DefinitionList of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts.
|
system | S Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdHealthcareService.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
start | S Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdHealthcareService.telecom.period.start Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known.
|
end | S Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdHealthcareService.telecom.period.end End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
|
coverageArea | I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdHealthcareService.coverageArea Location(s) service is intended for/available to DefinitionThe location(s) that this service is available to (not where the service is provided). The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".
|
serviceProvisionCode | 0..* | CodeableConceptBinding | Element IdHealthcareService.serviceProvisionCode Conditions under which service is available/offered DefinitionThe code(s) that detail the conditions under which the healthcare service is available/offered. The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply. The code(s) that detail the conditions under which the healthcare service is available/offered. ServiceProvisionConditions (extensible)Constraints
| |
eligibility | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.eligibility Specific eligibility requirements required to use the service DefinitionDoes this service have specific eligibility requirements that need to be met in order to use the service?
| |
code | S | 0..1 | CodeableConceptBinding | Element IdHealthcareService.eligibility.code Coded value for the eligibility DefinitionCoded value for the eligibility. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Coded values underwhich a specific service is made available. EligibilityCriteria (extensible)Constraints
|
comment | 0..1 | markdown | There are no (further) constraints on this element Element IdHealthcareService.eligibility.comment Describes the eligibility conditions for the service DefinitionDescribes the eligibility conditions for the service. The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.
| |
program | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.program Programs that this service is applicable to DefinitionPrograms that this service is applicable to. Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. Government or local programs that this service applies to. Program (example)Constraints
| |
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.program.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdHealthcareService.program.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.program.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdHealthcareService.program.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.program.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.program.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.program.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
characteristic | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.characteristic Collection of characteristics (attributes) DefinitionCollection of characteristics (attributes). These could be such things as is wheelchair accessible. A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). (unbound) (example)Constraints
| |
extension | I | 0..* | Extension | Element IdHealthcareService.characteristic.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
Facet | I | 0..* | Extension(CodeableConcept) | Element IdHealthcareService.characteristic.extension:Facet Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ehealthontario.ca/fhir/StructureDefinition/ext-facet Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdHealthcareService.characteristic.extension:Facet.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://ehealthontario.ca/fhir/StructureDefinition/ext-facet
| |
value[x] | S | 0..1 | Binding | There are no (further) constraints on this element Element IdHealthcareService.characteristic.extension:Facet.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). Codes representing semantic categories in a faceted taxonomy system. Facet (extensible)Constraints
|
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdHealthcareService.characteristic.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.characteristic.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
communication | 0..* | CodeableConceptBinding | Element IdHealthcareService.communication The language that this service is offered in DefinitionSome services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling. Languages understood or supported by Ontario clients and organizations. This value set represents the subset of all ISO living languages as of April 22, 2020. Language (preferred)Constraints
| |
referralMethod | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.referralMethod Ways that the service accepts referrals DefinitionWays that the service accepts referrals, if this is not provided then it is implied that no referral is required. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The methods of referral can be used when referring to a specific HealthCareService resource. ReferralMethod (example)Constraints
| |
appointmentRequired | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.appointmentRequired If an appointment is required for access to this service DefinitionIndicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
| |
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.availableTime Times the Service Site is available DefinitionA collection of times that the Service Site is available. More detailed availability information may be provided in associated Schedule/Slot resources.
| |
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdHealthcareService.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The time zone is expected to be for where this HealthcareService is provided at.
| |
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdHealthcareService.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The time zone is expected to be for where this HealthcareService is provided at.
| |
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.notAvailable Not available during this time due to provided reason DefinitionThe HealthcareService is not available during this period of time due to the provided reason.
| |
description | 1..1 | string | There are no (further) constraints on this element Element IdHealthcareService.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
during | I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.availabilityExceptions Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | S I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdHealthcareService.endpoint Technical endpoints providing access to electronic services operated for the healthcare service DefinitionTechnical endpoints providing access to services operated for the specific healthcare services defined at this resource. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
reference | S Σ I | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.endpoint.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | S Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdHealthcareService.endpoint.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdHealthcareService.endpoint.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.endpoint.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
Table View
HealthcareService | .. | |
HealthcareService.meta | 1.. | |
HealthcareService.meta.profile | 1.. | |
HealthcareService.meta.security | .. | |
HealthcareService.text | .. | |
HealthcareService.extension | 0.. | |
HealthcareService.extension | Extension | 0..1 |
HealthcareService.extension | Extension | 0.. |
HealthcareService.extension | Extension | 0..1 |
HealthcareService.extension | Extension | 0.. |
HealthcareService.identifier | .. | |
HealthcareService.identifier.use | .. | |
HealthcareService.identifier.type | .. | |
HealthcareService.identifier.type.coding | .. | |
HealthcareService.identifier.type.coding.system | .. | |
HealthcareService.identifier.type.coding.code | .. | |
HealthcareService.identifier.type.coding.display | .. | |
HealthcareService.identifier.system | .. | |
HealthcareService.identifier.value | .. | |
HealthcareService.identifier.assigner | .. | |
HealthcareService.active | 1.. | |
HealthcareService.providedBy | Reference(Organization) | .. |
HealthcareService.providedBy.display | 1.. | |
HealthcareService.category | .. | |
HealthcareService.type | .. | |
HealthcareService.type.extension | 0.. | |
HealthcareService.type.extension | Extension | 0..1 |
HealthcareService.type.extension | Extension | 0.. |
HealthcareService.type.coding | .. | |
HealthcareService.type.coding.system | .. | |
HealthcareService.type.coding.code | .. | |
HealthcareService.type.coding.display | .. | |
HealthcareService.location | Reference(Location) | .. |
HealthcareService.location.reference | .. | |
HealthcareService.location.display | .. | |
HealthcareService.name | .. | |
HealthcareService.comment | .. | |
HealthcareService.extraDetails | .. | |
HealthcareService.telecom | .. | |
HealthcareService.telecom.system | .. | |
HealthcareService.telecom.value | .. | |
HealthcareService.telecom.period | .. | |
HealthcareService.telecom.period.start | .. | |
HealthcareService.telecom.period.end | .. | |
HealthcareService.serviceProvisionCode | .. | |
HealthcareService.eligibility | .. | |
HealthcareService.eligibility.code | .. | |
HealthcareService.program | .. | |
HealthcareService.program.coding | .. | |
HealthcareService.program.coding.system | .. | |
HealthcareService.program.coding.code | .. | |
HealthcareService.program.coding.display | .. | |
HealthcareService.characteristic | .. | |
HealthcareService.characteristic.extension | 0.. | |
HealthcareService.characteristic.extension | Extension | 0.. |
HealthcareService.characteristic.extension.value[x] | .. | |
HealthcareService.communication | .. | |
HealthcareService.endpoint | .. | |
HealthcareService.endpoint.reference | .. | |
HealthcareService.endpoint.type | .. | |
HealthcareService.endpoint.identifier | .. | |
HealthcareService.endpoint.display | .. |
JSON View
{ "resourceType": "StructureDefinition", "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-HealthcareService", "version": "1.0.1", "name": "HealthcareService", "status": "draft", "description": "HealthcareService contains the details of a healthcare service available at a location.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "HealthcareService", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService", "derivation": "constraint", "differential": { "element": [ { "id": "HealthcareService.meta", "path": "HealthcareService.meta", "min": 1, "mustSupport": true }, { "id": "HealthcareService.meta.profile", "path": "HealthcareService.meta.profile", "comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.\n\n#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-HealthcareService|1.0.0 `_**", "min": 1, "mustSupport": true }, { "id": "HealthcareService.meta.security", "path": "HealthcareService.meta.security", "binding": { "strength": "extensible", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/security-labels" } }, { "id": "HealthcareService.text", "path": "HealthcareService.text", "mustSupport": true }, { "id": "HealthcareService.extension", "path": "HealthcareService.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "HealthcareService.extension:UsageLicense", "path": "HealthcareService.extension", "sliceName": "UsageLicense", "definition": "Extension to describe the licensing conditions under which this HealthcareService (and related) resources may be used.", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ext-usage-license" ] } ], "isModifier": false }, { "id": "HealthcareService.extension:Media", "path": "HealthcareService.extension", "sliceName": "Media", "definition": "Extension to capture photos, documents and files that relate to a HealthcareService.", "min": 0, "type": [ { "code": "Extension", "profile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ext-media" ] } ], "isModifier": false }, { "id": "HealthcareService.extension:AccessInstructions", "path": "HealthcareService.extension", "sliceName": "AccessInstructions", "definition": "Extension describes how a person gets started with this HealthcareService.", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ext-access-instructions" ] } ], "isModifier": false }, { "id": "HealthcareService.extension:DeliveryMethod", "path": "HealthcareService.extension", "sliceName": "DeliveryMethod", "definition": "Extension to describe how the service is delivered to the client. Usually there is only one deliveryMethod, but in some case there are multiple (e.g., On “site” counseling with a “video-call” option.)", "min": 0, "type": [ { "code": "Extension", "profile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ext-delivery-method" ] } ], "isModifier": false }, { "id": "HealthcareService.identifier", "path": "HealthcareService.identifier", "mustSupport": true }, { "id": "HealthcareService.identifier.use", "path": "HealthcareService.identifier.use", "binding": { "strength": "required", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/ereferral-identifier-use" } }, { "id": "HealthcareService.identifier.type", "path": "HealthcareService.identifier.type", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/ereferral-identifier-type" } }, { "id": "HealthcareService.identifier.type.coding", "path": "HealthcareService.identifier.type.coding", "mustSupport": true }, { "id": "HealthcareService.identifier.type.coding.system", "path": "HealthcareService.identifier.type.coding.system", "mustSupport": true }, { "id": "HealthcareService.identifier.type.coding.code", "path": "HealthcareService.identifier.type.coding.code", "mustSupport": true }, { "id": "HealthcareService.identifier.type.coding.display", "path": "HealthcareService.identifier.type.coding.display", "mustSupport": true }, { "id": "HealthcareService.identifier.system", "path": "HealthcareService.identifier.system", "mustSupport": true }, { "id": "HealthcareService.identifier.value", "path": "HealthcareService.identifier.value", "mustSupport": true }, { "id": "HealthcareService.identifier.assigner", "path": "HealthcareService.identifier.assigner", "mustSupport": true }, { "id": "HealthcareService.active", "path": "HealthcareService.active", "min": 1 }, { "id": "HealthcareService.providedBy", "path": "HealthcareService.providedBy", "type": [ { "code": "Reference", "targetProfile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Organization" ] } ], "mustSupport": true }, { "id": "HealthcareService.providedBy.display", "path": "HealthcareService.providedBy.display", "min": 1, "mustSupport": true }, { "id": "HealthcareService.category", "path": "HealthcareService.category", "comment": "Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.\nThe high level healthcare sector of the listing. (e.g., Mental health service, Community health services, Laboratory service, etc)", "binding": { "strength": "extensible", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/healthcareservice-categories" } }, { "id": "HealthcareService.type", "path": "HealthcareService.type", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.\n\n<a href=\"https://tgateway.infoway-inforoute.ca/singlesubset.html?id=2.16.840.1.113883.3.239.12.38&versionid=20220429\">LINK TO VALUE SET</a>", "mustSupport": true, "binding": { "strength": "preferred", "description": "Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient.", "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/practitionerspecialty" } }, { "id": "HealthcareService.type.extension", "path": "HealthcareService.type.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "HealthcareService.type.extension:PrimaryType", "path": "HealthcareService.type.extension", "sliceName": "PrimaryType", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ext-primary-type" ] } ], "isModifier": false }, { "id": "HealthcareService.type.extension:Facet", "path": "HealthcareService.type.extension", "sliceName": "Facet", "min": 0, "type": [ { "code": "Extension", "profile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ext-facet" ] } ], "mustSupport": true, "isModifier": false }, { "id": "HealthcareService.type.coding", "path": "HealthcareService.type.coding", "mustSupport": true }, { "id": "HealthcareService.type.coding.system", "path": "HealthcareService.type.coding.system", "mustSupport": true }, { "id": "HealthcareService.type.coding.code", "path": "HealthcareService.type.coding.code", "mustSupport": true }, { "id": "HealthcareService.type.coding.display", "path": "HealthcareService.type.coding.display", "mustSupport": true }, { "id": "HealthcareService.location", "path": "HealthcareService.location", "type": [ { "code": "Reference", "targetProfile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Location" ] } ], "mustSupport": true }, { "id": "HealthcareService.location.reference", "path": "HealthcareService.location.reference", "mustSupport": true }, { "id": "HealthcareService.location.display", "path": "HealthcareService.location.display", "mustSupport": true }, { "id": "HealthcareService.name", "path": "HealthcareService.name", "mustSupport": true }, { "id": "HealthcareService.comment", "path": "HealthcareService.comment", "mustSupport": true }, { "id": "HealthcareService.extraDetails", "path": "HealthcareService.extraDetails", "mustSupport": true }, { "id": "HealthcareService.telecom", "path": "HealthcareService.telecom", "mustSupport": true }, { "id": "HealthcareService.telecom.system", "path": "HealthcareService.telecom.system", "mustSupport": true }, { "id": "HealthcareService.telecom.value", "path": "HealthcareService.telecom.value", "mustSupport": true }, { "id": "HealthcareService.telecom.period.start", "path": "HealthcareService.telecom.period.start", "mustSupport": true }, { "id": "HealthcareService.telecom.period.end", "path": "HealthcareService.telecom.period.end", "mustSupport": true }, { "id": "HealthcareService.serviceProvisionCode", "path": "HealthcareService.serviceProvisionCode", "binding": { "strength": "extensible", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/service-provision-conditions" } }, { "id": "HealthcareService.eligibility.code", "path": "HealthcareService.eligibility.code", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/eligibility-criteria" } }, { "id": "HealthcareService.program.coding.system", "path": "HealthcareService.program.coding.system", "mustSupport": true }, { "id": "HealthcareService.program.coding.code", "path": "HealthcareService.program.coding.code", "mustSupport": true }, { "id": "HealthcareService.program.coding.display", "path": "HealthcareService.program.coding.display", "mustSupport": true }, { "id": "HealthcareService.characteristic.extension", "path": "HealthcareService.characteristic.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "HealthcareService.characteristic.extension:Facet", "path": "HealthcareService.characteristic.extension", "sliceName": "Facet", "min": 0, "type": [ { "code": "Extension", "profile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ext-facet" ] } ], "isModifier": false }, { "id": "HealthcareService.characteristic.extension:Facet.value[x]", "path": "HealthcareService.characteristic.extension.value[x]", "mustSupport": true }, { "id": "HealthcareService.communication", "path": "HealthcareService.communication", "binding": { "strength": "preferred", "description": "Languages understood or supported by Ontario clients and organizations. This value set represents the subset of all ISO living languages as of April 22, 2020.", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/human-language" } }, { "id": "HealthcareService.endpoint", "path": "HealthcareService.endpoint", "mustSupport": true }, { "id": "HealthcareService.endpoint.reference", "path": "HealthcareService.endpoint.reference", "mustSupport": true }, { "id": "HealthcareService.endpoint.type", "path": "HealthcareService.endpoint.type", "mustSupport": true }, { "id": "HealthcareService.endpoint.identifier", "path": "HealthcareService.endpoint.identifier", "mustSupport": true }, { "id": "HealthcareService.endpoint.display", "path": "HealthcareService.endpoint.display", "mustSupport": true } ] } }
Usage
The HealthcareService resource is used to describe a healthcare service provided by an organization at a location.
Notes
.id
- used to uniquely identify the resource
- if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in
Bundle.entry.fullUrl
)
.meta.profile
- used to declare conformance to this profile
- populate with a fixed value:
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-HealthcareService|1.0.0
.meta.security
- used to identify if the HealthcareService resource is the master record, copy of a master record, or a draft record in a federated network of HealthcareService directories
- SHOULD be populated with one of the following codes:
MASTERMark
- It is the Master Record managed by a Master Record Holder (MRH), for use in a federated network of HealthcareService directories.COPYMark
- if it is a copy of a Master Record in a federated systemDRAFTMark
- if the HealthcareService is still under developmentNOREUSE
- Marks the prohibition on the use of the information beyond the use initially authorized (which can be found in the usage-licence extension)
.text
- SHOULD display an HTML summary of the resource. Treat it as content which could be displayed when reviewing the service in a viewer (like a website or EMR)
.text.status
- SHOULD be set to
generated
in most cases, as it is a computer generated summary computer assembled from the HealthcareService elements. See Narrative Status ValueSet
.text.div
Holds the basic HTML version of the HealthcareService summarized
General recommended format is bold label, colon separator and value - but this is not a hard rule. E.g.
Name: Northern Senior’s Services
Provided by: True North Health Clinic
Type: Meals on Wheels, Transportation
.extension:usage-license
- Describes the licensing conditions under which this HealthcareService (and related resources) may be used
.extension:media
Photos, documents and files that relate to a HealthcareService
File size and type constraints to be determined by implementation partners
Restricted to “safe” data types
Images: jpeg, jpg, png, gif, ico
Documents: pdf
Video: youtube or vimeo links
Note: Use the “.url” not “.data” field, to prevent search API filesizes from being too large.
.extension:AccessInstructions
- Describes the process for how to get started with this HealthcareService
- Use markdown because this often contains links to external sites
.extension:delivery-method
- Describes how the service is delivered to the client, usually there is only one deliveryMethod, but in some cases there are multiple (e.g., On “site” counseling with a “video-call” option.)
- For example, home visit, telephone encounters, in person, etc.
.identifier
- Business identifier(s) that are specific to this HealthcareService
- Identifiers corresponding to clinician qualifications (such as CPSO number) SHOULD be included in the Practitioner resource not HealthcareService
- HealthcareService identifiers can be applied in a generic way, with no special constraints
- MAY contain multiple identifiers such as directory identifiers (e.g., 211), industry issued identifiers (e.g., pharmacy IDs), local system identifiers, and master identifiers in a federated data sharing model.
- For additional information and implementation guidance on Identifiers, please see the Identifiers section under HealthcareService Directories on the Business Rules page of this implementation guide
identifier.use
- SHOULD contain a code of
official
for master record identifier and any official externally granted identifiers (e.g., pharmacy ID). - SHOULD contain a code of
secondary
for local identifiers and other identifiers which are not the master recorded (in a federated data sharing model), not issued by a master record holder.
identifier.type
- When populated, SHALL contain a code of
HCS
representing HealthcareService
identifier.system
- The namespace for the identifier value (i.e., the “source identifier issuer system”), where the value must be unique within the system.
- Different HealthcareService directories MAY apply their own system to share their local identifier for the HealthcareService, e.g.,
www.hcs-directory-app.com/fhir/sid/listing-id
identifier.value
- SHOULD contain a unique value for the identifier within its system
- Master Record identifiers (generated by a Master Record Holder, MRH) SHALL use UUIDs or some other globally unique naming convention.
identifier.assigner
- MAY contain a reference to the organization issuing the identifier
- MAY contain only a string of text
active
- SHALL be populated with
true
if the service is available and active - SHALL be populated with
false
if the service has been deactivated - NOTE: HealthcareServices should only become “.active=false”, never deleted, this will ensure that historical actions related to the service can maintain their referential integrity.
- The concept of temporarily “Suspended” services can be handled via the corresponding Location.status=active.
providedBy
- The Organization providing the services, if multiple agencies are providing the service, select the single organization that is the primary lead of the service
- SHOULD be populated with a reference to the Organization where the services are being offered
- NOTE: referrals must be made to a HealthcareService which has an organization, never directly to the organization.
providedBy.reference
- SHOULD contain a literal reference, relative, internal or absolute URL
providedBy.identifier
- MAY include any identifiers associated with the referenced Organization resource
providedBy.type
- SHOULD be populated with
Organization
providedBy.display
- SHALL be populated with a string of the organization name. e.g., “Canadian Red Cross - Barrie Branch”
category
- The highlevel healthcare sector of the listing
- SHOULD be populated with a code from the value set representing the healthcare sector of the listing
- SHALL NOT be used for taxonomy classification, use .type for taxonomy
type
- SHALL be used to classify HealthcareService directories into taxonomies
- supports single tag based, multi-tag, multi-tag with a primary tag, hierarchical, faceted or a combination of these taxonomy approaches
- For additional information and implementation guidance on the Taxonomies supported in the
.type
element, please refer to the Taxonomy section on the Business Rules page of this implementation guide
type.extension:PrimaryType
- SHOULD be used for multi-tag taxonomies where the primary tag needs to be identified
type.extension:Facet
- SHOULD be used in a faceted taxonomy to represent each facet category
specialty
- SHALL NOT be used to express specialties handled by the service site, use
.type
for speciality and sub-specialty, please refer to the Taxonomy section for more information
location
- identifies the Location(s) where the services may be provided
- SHOULD be populated with a reference to the Location where the services are being provided
- For additional information and implementation guidance on the use of
.location
, please see the Location section on the Business Rules page of this implementation guide
location.reference
- MAY contain a literal reference, relative, internal or absolute URL
location.type
- SHOULD be populated with
Location
location.identifer
- MAY contain identifiers associated with the referenced Location resource
location.display
- MAY contain the full address(es) of the service
- Address(es) SHOULD be resolvable by geo-code APIs such as Google Maps (e.g., 10 Main st, Toronto, Ontario, Canada)
name
- SHOULD contain the name of the healthcareService presented to the consumer & referrer, e.g., "Lakeshore Adult Day Program"
comment
- SHOULD include the PRIMARY summary description details about a service. This would be presented to users as the quick summary information about a service in search. Its content should be kept short.
extraDetails
- SHOULD include the SECONDARY description details about a service (which may be omitted from a service summary, or accessible through "view more" options)
- MAY hold data from specialized fields that are part of a specialized directory, but are not part of this specification. These extra fields can be formatted visually with Markdown to simulate how the might commonly be displayed as proper data fields.
E.g., Accessibility: Wheelchair accessible.
However, the handling of these additional fields is better served with the “.characteristics” field.
photo
- MAY contain a hero image of the service to visually facilitate quick identification of the services
- MAY be shown as a thumbnail in search results, or as a hero photo in service listings page.
- Use
photo.url
rather thanphoto.data
, to keep payloads small.
telecom
- The inquiry phone, email, fax and informational web page for this service
- For URLs, SHOULD contain only a single URL unless referencing additional social media related URLs
- SHOULD contain telecom related information for the purpose of Access information (e.g. when a person calls to ask for information related to the offered services)
- For additional information and implementation guidance on the use of
.telecom
, please see the Telecom section on the Business Rules page of this implementation guide
telecom.system
- SHOULD contain a code representing the telecom type (e.g. phone for phone number, url for website, etc.)
- Pager, url, sms and other have limited practical use for HelathcareService directories
- There SHALL be only be ONE url telecom, unless the additional urls reference common social urls in their path (i.e., facebook, linkedIn, instagram, tiktok).
telecom.value
- SHOULD contain the contact point details (e.g. string containing telephone number)
telecom.use
- When populated, SHALL always contain
work
for HealthcareService
telecom.rank
- When more than one ContactPoint of the same system, SHOULD be ordered by priority rank
telecom.period
- MAY contain the time period when the ContactPoint was/is in use
coverageArea
- A coverageArea can be thought of as an “eligibility area”. It is more relevant to some delivery methods (e.g. home visits) than others.
- A coverage area is represented by GeoJSON shapefiles, which can be a single shape or a multi-shape (see www.geojson.io)
- The GeoJSON shapefile is included in the referenced Location resource using the boundary-geojson extension (via HealthcareSerivce.coverageArea > Location.extension.location-boundary-geojson.url). Shapefiles can be large, so reference them using the extension’s url field for asynchronous retrieval, rather than including them in payloads.
- There are special rules for the use of coverageArea in conjunction with the deliveryMethod extension
- “home”, “phone”, “video” SHOULD have a coverageArea
- Remaining deliveryMethods MAY have a coverageArea
coverageArea.reference
- SHOULD be populated with a reference to the Location resource
coverageArea.type
- SHOULD be populated with
Location
coverageArea.identifier
- MAY contain identifiers associated with the referenced Location resource
- This field is not expected to have significant use for HealthcareService directories.
coverageArea.display
- SHOULD contain the descriptive name of the coverageArea shape (e.g. City of Thunder Bay, Town of Orangeville)
serviceProvisionCode
- SHOULD be populated with
free
for no charge services or those covered under provincial insurance - SHOULD be populated with
fees-apply
for services that are not free and not covered under provincial insurance - e.g. coding.code=free coding.display=Free .text = Free (may add additional narrative colour here, such as “Covered by OHIP”
eligibility
- Eligibility SHOULD be expressed in way that can be agreed to with a “yes/no”, "met/unmet" statement (e.g. Is the registrant over the age of 18?) so that applications can clearly ask users if they meet the eligibility criteria (yes/no) before proceeding to a referral step (e.g. The registrant is a resident of Toronto)
- Avoid putting multiple eligibility criteria into a single data row, instead express each criteria as its own entry.
- Express free text with yes/no, yes=pass questions using ‘.eligibility.comment’ (e.g. is a resident of Toronto)
eligibility.code
- For uncoded eligibility statements, use only the eligibility.code.text field
- Eligibility coding (e.g., “non-smoker) can help with search/match functions. If coding is available, then also use eligibility.code.coding
program
- Used to group services provided by one or many organizations under a formal “program” label program, e.g. Ontario eConsult, Eastern Immunization Program, Canada Craving Change
- Since the creation (and dissolution) of programs is very dynamic, it is unlikely that a central coding system will be available for this, so be sure to use at least the .text element in the CodeableConcept for human readability. Using coding will be necessary to enable filtered search by program.
- For additional information and implementation guidance on the use of
.program
, please see the Program section on the Business Rules page of this implementation guide
program.text
- SHOULD contain a human readable string containing the program name
characteristic
- MAY contain additional “tags” or “keywords” that a specialized HealthcareService directory may have, but do not apply to the other fields within this resource
- Faceted tags SHOULD be applied using the Facet extension on .characteristic
- For additional information and implementation guidance on the use of
.characteristic
, please see the Characteristic section on the Business Rules page of this implementation guide
characteristic.coding
- MAY contain the codes related to a local coding system
- Basic tags using a flat tagging structure SHOULD be applied here
characteristic.text
- MAY contain the “tag” or "keyword" used to communicate additional data fields related to a HealthcareService
communication
- SHOULD contain the language this HealthcareService is offered in
appointmentRequired
- Indicates that a referral will only be accepted in conjunction with an appointment booking
availableTime
- Used to represent the Access Hours (i.e. when someone can call to get started or ask for information) and not Operational Hours
- For additional information and implementation guidance on the use of
.availableTime
, please see the Available Time section on the Business Rules page of this implementation guide
availableTime.daysOfWeek
- MAY contain a code representing the day(s) of the week the service is accessible, one or more of mon | tue | wed | thu | fri | sat | sun
.availableTime.allDay
- SHOULD be set to true for 24 hour service
availableTime.availableStartTime
- MAY contain opening time of day (ignore if .allDay = true)
availableTime.availableEndTime
- MAY contain closing time fo day (ignore if .allDay = true)
notAvailable
Not available during this time due to the provided reason (in .description).
The notAvailable time is computable so long as “during” is included. If “during” is omitted then the “description” is a simple text description of when not available (e.g., Christmas, new years)
notAvailable.description
- SHOULD contain a text description reason presented to the user about why the time is not available (e.g. New Years)
notAvailable.during
- SHOULD contain a date range of when services are not available
endpoint
- SHOULD contain technical endpoints providing access to services operated for the location including:
- Retrieving the master record for this HealthcareService
- Submitting a ServiceRequest
- Referral webpage URLs
- SMART on FHIR URLs
- Referral Questionnaires
- For additional information and implementation guidance on the use of
.endpoint
, please see the Endpoint section on the Business Rules page of this implementation guide
endpoint.type
- SHOULD be populated with
Endpoint
endpoint.display
- MAY display the endpoint name
Search Parameters
Name | Parameter | Description | Sample Expression |
---|---|---|---|
identifier | HealthcareService.identifier | Identifier codes for the service. | GET [BASE]/HealthcareService?identifier=6687452 |