DFT Ballot - The specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. . . For a full list of available versions, see the Directory of published versions
HealthcareService
Links
Profile
Derived from
https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.HealthcareService
Description
A HealthcareService will have a unique identifier. Healthcare services include, but are not limited to, primary care, home care, or in patient care such as surgical services. Additional attributes such as location of service, contract person, hours of operation etc. can be included.
References to this resource
Resource Content
HealthcareService | I | ||
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..0 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
deliveryMethod | I | 0..* | Extension(code) |
usageLicense | I | 0..* | Extension(url) |
modifierExtension | ?! I | 0..0 | Extension |
identifier | S Σ | 1..* | Identifier |
active | S Σ ?! | 1..1 | boolean |
providedBy | S Σ | 0..1 | Reference(Organization) |
category | S Σ | 0..* | CodeableConcept |
type | S Σ | 1..* | CodeableConcept |
specialty | Σ | 0..* | CodeableConceptBinding |
location | S Σ | 0..* | Reference(Location) |
name | S Σ | 1..1 | string |
comment | Σ | 0..1 | string |
extraDetails | 0..1 | markdown | |
photo | Σ | 0..1 | Attachment |
telecom | 0..* | ContactPoint | |
coverageArea | 0..* | Reference(Location) | |
serviceProvisionCode | 0..* | CodeableConcept | |
eligibility | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | 0..1 | CodeableConcept | |
comment | 0..1 | markdown | |
program | 0..* | CodeableConcept | |
characteristic | 0..* | CodeableConcept | |
communication | 0..* | CodeableConceptBinding | |
referralMethod | 0..* | CodeableConcept | |
appointmentRequired | 0..1 | boolean | |
availableTime | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
daysOfWeek | 0..* | codeBinding | |
allDay | 0..1 | boolean | |
availableStartTime | 0..1 | time | |
availableEndTime | 0..1 | time | |
notAvailable | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
description | 1..1 | string | |
during | 0..1 | Period | |
availabilityExceptions | 0..1 | string | |
endpoint | 0..* | Reference(Endpoint) |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="CA-CSD-HealthcareService" /> <extension url="http://hl7.org/fhir/StructureDefinition/obligation"> <extension url="code"> <valueCode value="SHALL:able-to-populate" /> </extension> <extension url="code"> <valueCode value="SHOULD:populate" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.identifier" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.active" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.providedBy" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.type" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.location" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.name" /> </extension> <extension url="actor"> <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server" /> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/obligation"> <extension url="code"> <valueCode value="SHALL:no-error" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.identifier" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.active" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.providedBy" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.type" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.location" /> </extension> <extension url="elementId"> <valueString value="HealthcareService.name" /> </extension> <extension url="actor"> <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client" /> </extension> </extension> <url value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-HealthcareService" /> <name value="HealthcareService" /> <status value="draft" /> <description value="A HealthcareService will have a unique identifier. Healthcare services include, but are not limited to, primary care, home care, or in patient care such as surgical services. Additional attributes such as location of service, contract person, hours of operation etc. can be included." /> <copyright value="Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="HealthcareService" /> <baseDefinition value="https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.HealthcareService" /> <derivation value="constraint" /> <differential> <element id="HealthcareService.meta.lastUpdated"> <path value="HealthcareService.meta.lastUpdated" /> <comment value="Identified as a query requirement through mCSD CapabilityStatement." /> <mustSupport value="true" /> </element> <element id="HealthcareService.extension:deliveryMethod"> <path value="HealthcareService.extension" /> <sliceName value="deliveryMethod" /> <type> <code value="Extension" /> <profile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/delivery-method" /> </type> </element> <element id="HealthcareService.extension:usageLicense"> <path value="HealthcareService.extension" /> <sliceName value="usageLicense" /> <type> <code value="Extension" /> <profile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/usage-license" /> </type> </element> <element id="HealthcareService.identifier"> <path value="HealthcareService.identifier" /> <comment value="Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="HealthcareService.active"> <path value="HealthcareService.active" /> <comment value="Identified as a query requirement through mCSD CapabilityStatement." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="HealthcareService.providedBy"> <path value="HealthcareService.providedBy" /> <comment value="This is a mustSupport element in the Ontario eServices profile. Allows the search to return the organization without having to go through the practitionerRole resource." /> <type> <code value="Reference" /> <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" /> </type> <mustSupport value="true" /> </element> <element id="HealthcareService.category"> <path value="HealthcareService.category" /> <comment value="Identified as a requirement through stakeholder engagement at Plugathon. Used to identify broad service category for increased human readability, so that users can make appropriate decision on where to send information." /> <mustSupport value="true" /> </element> <element id="HealthcareService.type"> <path value="HealthcareService.type" /> <comment value="Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Currently being used for system readability and tracking." /> <mustSupport value="true" /> </element> <element id="HealthcareService.location"> <path value="HealthcareService.location" /> <comment value="Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Allows the search to return the location without having to go through the practitionerRole resource." /> <type> <code value="Reference" /> <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location" /> </type> <mustSupport value="true" /> </element> <element id="HealthcareService.name"> <path value="HealthcareService.name" /> <comment value="Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated." /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:able-to-populate" }, { "url": "code", "valueCode": "SHOULD:populate" }, { "url": "elementId", "valueString": "HealthcareService.identifier" }, { "url": "elementId", "valueString": "HealthcareService.active" }, { "url": "elementId", "valueString": "HealthcareService.providedBy" }, { "url": "elementId", "valueString": "HealthcareService.type" }, { "url": "elementId", "valueString": "HealthcareService.location" }, { "url": "elementId", "valueString": "HealthcareService.name" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:no-error" }, { "url": "elementId", "valueString": "HealthcareService.identifier" }, { "url": "elementId", "valueString": "HealthcareService.active" }, { "url": "elementId", "valueString": "HealthcareService.providedBy" }, { "url": "elementId", "valueString": "HealthcareService.type" }, { "url": "elementId", "valueString": "HealthcareService.location" }, { "url": "elementId", "valueString": "HealthcareService.name" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client" } ] } ], "id": "CA-CSD-HealthcareService", "url": "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-HealthcareService", "name": "HealthcareService", "description": "A HealthcareService will have a unique identifier. Healthcare services include, but are not limited to, primary care, home care, or in patient care such as surgical services. Additional attributes such as location of service, contract person, hours of operation etc. can be included.", "status": "draft", "copyright": "Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "HealthcareService", "baseDefinition": "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.HealthcareService", "derivation": "constraint", "differential": { "element": [ { "id": "HealthcareService.meta.lastUpdated", "path": "HealthcareService.meta.lastUpdated", "comment": "Identified as a query requirement through mCSD CapabilityStatement.", "mustSupport": true }, { "id": "HealthcareService.extension:deliveryMethod", "path": "HealthcareService.extension", "sliceName": "deliveryMethod", "type": [ { "code": "Extension", "profile": [ "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/delivery-method" ] } ] }, { "id": "HealthcareService.extension:usageLicense", "path": "HealthcareService.extension", "sliceName": "usageLicense", "type": [ { "code": "Extension", "profile": [ "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/usage-license" ] } ] }, { "id": "HealthcareService.identifier", "path": "HealthcareService.identifier", "min": 1, "comment": "Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile.", "mustSupport": true }, { "id": "HealthcareService.active", "path": "HealthcareService.active", "min": 1, "comment": "Identified as a query requirement through mCSD CapabilityStatement.", "mustSupport": true }, { "id": "HealthcareService.providedBy", "path": "HealthcareService.providedBy", "comment": "This is a mustSupport element in the Ontario eServices profile. Allows the search to return the organization without having to go through the practitionerRole resource.", "type": [ { "code": "Reference", "targetProfile": [ "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" ] } ], "mustSupport": true }, { "id": "HealthcareService.category", "path": "HealthcareService.category", "comment": "Identified as a requirement through stakeholder engagement at Plugathon. Used to identify broad service category for increased human readability, so that users can make appropriate decision on where to send information.", "mustSupport": true }, { "id": "HealthcareService.type", "path": "HealthcareService.type", "comment": "Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Currently being used for system readability and tracking.", "mustSupport": true }, { "id": "HealthcareService.location", "path": "HealthcareService.location", "comment": "Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Allows the search to return the location without having to go through the practitionerRole resource.", "type": [ { "code": "Reference", "targetProfile": [ "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location" ] } ], "mustSupport": true }, { "id": "HealthcareService.name", "path": "HealthcareService.name", "comment": "Identified as a query requirement through mCSD CapabilityStatement. This is a mustSupport element in the Ontario eServices profile. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.", "mustSupport": true } ] } }
Terminology bindings
Constraints
Obligations
Obligations | Actor | Element |
---|---|---|
SHALL:able-to-populate; SHOULD:populate | http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server | HealthcareService.identifier; HealthcareService.active; HealthcareService.providedBy; HealthcareService.type; HealthcareService.location; HealthcareService.name |
SHALL:no-error | http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client | HealthcareService.identifier; HealthcareService.active; HealthcareService.providedBy; HealthcareService.type; HealthcareService.location; HealthcareService.name |