Profiles & Interactions > Structure Definition: HealthcareService Profile
Profile: HealthCareService
Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-healthcareservice
Simplifier project page: MHA Healthcare Service
Derived from: HealthcareService (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
| HealthcareService | S C | HealthcareService | |
| id | Σ | 0..1 | id |
| meta | S Σ | 1..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | S Σ | 1..1 | canonical(StructureDefinition)Fixed Value |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 1..* | Extension |
| functionalCentreCode | S C | 1..1 | Extension(CodeableConcept) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | S | 1..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | S Σ | 1..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | S Σ | 1..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | S Σ | 1..* | Identifier |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| sliceIdentifier-HSPProgramID | S Σ | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | S Σ ?! | 1..1 | codeBindingFixed Value |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| sliceIdentifier-ConnexHealthProgramNumber | S Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | S Σ ?! | 1..1 | codeBindingFixed Value |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| active | Σ ?! | 0..1 | boolean |
| providedBy | S Σ C | 0..1 | Reference(Organization) |
| category | Σ | 0..* | CodeableConcept |
| type | Σ | 0..* | CodeableConcept |
| specialty | Σ | 0..* | CodeableConceptBinding |
| location | S Σ C | 0..* | Reference(LocationProfile) |
| name | S Σ | 1..1 | string |
| comment | Σ | 0..1 | string |
| extraDetails | 0..1 | markdown | |
| photo | Σ C | 0..1 | Attachment |
| telecom | C | 0..* | ContactPoint |
| coverageArea | C | 0..* | Reference(Location) |
| serviceProvisionCode | 0..* | CodeableConcept | |
| eligibility | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 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 | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 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 | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| description | 1..1 | string | |
| during | C | 0..1 | Period |
| availabilityExceptions | 0..1 | string | |
| endpoint | C | 0..* | Reference(Endpoint) |
Hybrid View
| HealthcareService | S C | HealthcareService | |
| id | Σ | 0..1 | id |
| meta | S Σ | 1..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | S Σ | 1..1 | canonical(StructureDefinition)Fixed Value |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 1..* | Extension |
| functionalCentreCode | S C | 1..1 | Extension(CodeableConcept) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | S | 1..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | S Σ | 1..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | S Σ | 1..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | S Σ | 1..* | Identifier |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| sliceIdentifier-HSPProgramID | S Σ | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | S Σ ?! | 1..1 | codeBindingFixed Value |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| sliceIdentifier-ConnexHealthProgramNumber | S Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | S Σ ?! | 1..1 | codeBindingFixed Value |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| active | Σ ?! | 0..1 | boolean |
| providedBy | S Σ C | 0..1 | Reference(Organization) |
| category | Σ | 0..* | CodeableConcept |
| type | Σ | 0..* | CodeableConcept |
| specialty | Σ | 0..* | CodeableConceptBinding |
| location | S Σ C | 0..* | Reference(LocationProfile) |
| name | S Σ | 1..1 | string |
| comment | Σ | 0..1 | string |
| extraDetails | 0..1 | markdown | |
| photo | Σ C | 0..1 | Attachment |
| telecom | C | 0..* | ContactPoint |
| coverageArea | C | 0..* | Reference(Location) |
| serviceProvisionCode | 0..* | CodeableConcept | |
| eligibility | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 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 | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 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 | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| description | 1..1 | string | |
| during | C | 0..1 | Period |
| availabilityExceptions | 0..1 | string | |
| endpoint | C | 0..* | Reference(Endpoint) |
Snapshot View
| HealthcareService | S C | HealthcareService | |
| id | Σ | 0..1 | id |
| meta | S Σ | 1..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | S Σ | 1..1 | canonical(StructureDefinition)Fixed Value |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 1..* | Extension |
| functionalCentreCode | S C | 1..1 | Extension(CodeableConcept) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | S | 1..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | S Σ | 1..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | S Σ | 1..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | S Σ | 1..* | Identifier |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| sliceIdentifier-HSPProgramID | S Σ | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | S Σ ?! | 1..1 | codeBindingFixed Value |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| sliceIdentifier-ConnexHealthProgramNumber | S Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | S Σ ?! | 1..1 | codeBindingFixed Value |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| active | Σ ?! | 0..1 | boolean |
| providedBy | S Σ C | 0..1 | Reference(Organization) |
| category | Σ | 0..* | CodeableConcept |
| type | Σ | 0..* | CodeableConcept |
| specialty | Σ | 0..* | CodeableConceptBinding |
| location | S Σ C | 0..* | Reference(LocationProfile) |
| name | S Σ | 1..1 | string |
| comment | Σ | 0..1 | string |
| extraDetails | 0..1 | markdown | |
| photo | Σ C | 0..1 | Attachment |
| telecom | C | 0..* | ContactPoint |
| coverageArea | C | 0..* | Reference(Location) |
| serviceProvisionCode | 0..* | CodeableConcept | |
| eligibility | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 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 | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 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 | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| description | 1..1 | string | |
| during | C | 0..1 | Period |
| availabilityExceptions | 0..1 | string | |
| endpoint | C | 0..* | Reference(Endpoint) |
Table View
| HealthcareService | 0..* | |
| HealthcareService.id | string | 0..1 |
| HealthcareService.meta | Meta | 1..1 |
| HealthcareService.meta.id | string | 0..1 |
| HealthcareService.meta.extension | Extension | 0..* |
| HealthcareService.meta.versionId | id | 0..1 |
| HealthcareService.meta.lastUpdated | instant | 0..1 |
| HealthcareService.meta.source | uri | 0..1 |
| HealthcareService.meta.profile | canonical(StructureDefinition) | 1..1 |
| HealthcareService.meta.security | Coding | 0..* |
| HealthcareService.meta.tag | Coding | 0..* |
| HealthcareService.implicitRules | uri | 0..1 |
| HealthcareService.language | code | 0..1 |
| HealthcareService.text | Narrative | 0..1 |
| HealthcareService.contained | Resource | 0..* |
| HealthcareService.extension | Extension | 1..* |
| HealthcareService.extension:functionalCentreCode | Extension | 1..1 |
| HealthcareService.extension:functionalCentreCode.id | string | 0..1 |
| HealthcareService.extension:functionalCentreCode.extension | Extension | 0..* |
| HealthcareService.extension:functionalCentreCode.url | uri | 1..1 |
| HealthcareService.extension:functionalCentreCode.value[x] | CodeableConcept | 1..1 |
| HealthcareService.extension:functionalCentreCode.value[x].id | string | 0..1 |
| HealthcareService.extension:functionalCentreCode.value[x].extension | Extension | 0..* |
| HealthcareService.extension:functionalCentreCode.value[x].coding | Coding | 1..1 |
| HealthcareService.extension:functionalCentreCode.value[x].coding.id | string | 0..1 |
| HealthcareService.extension:functionalCentreCode.value[x].coding.extension | Extension | 0..* |
| HealthcareService.extension:functionalCentreCode.value[x].coding.system | uri | 1..1 |
| HealthcareService.extension:functionalCentreCode.value[x].coding.version | string | 0..1 |
| HealthcareService.extension:functionalCentreCode.value[x].coding.code | code | 1..1 |
| HealthcareService.extension:functionalCentreCode.value[x].coding.display | string | 1..1 |
| HealthcareService.extension:functionalCentreCode.value[x].coding.userSelected | boolean | 0..1 |
| HealthcareService.extension:functionalCentreCode.value[x].text | string | 0..1 |
| HealthcareService.modifierExtension | Extension | 0..* |
| HealthcareService.identifier | Identifier | 1..* |
| HealthcareService.identifier.id | string | 0..1 |
| HealthcareService.identifier.extension | Extension | 0..* |
| HealthcareService.identifier.use | code | 0..1 |
| HealthcareService.identifier.type | CodeableConcept | 0..1 |
| HealthcareService.identifier.system | uri | 1..1 |
| HealthcareService.identifier.value | string | 1..1 |
| HealthcareService.identifier.period | Period | 0..1 |
| HealthcareService.identifier.assigner | Reference(Organization) | 0..1 |
| HealthcareService.identifier:sliceIdentifier-HSPProgramID | Identifier | 1..1 |
| HealthcareService.identifier:sliceIdentifier-HSPProgramID.id | string | 0..1 |
| HealthcareService.identifier:sliceIdentifier-HSPProgramID.extension | Extension | 0..* |
| HealthcareService.identifier:sliceIdentifier-HSPProgramID.use | code | 1..1 |
| HealthcareService.identifier:sliceIdentifier-HSPProgramID.type | CodeableConcept | 0..1 |
| HealthcareService.identifier:sliceIdentifier-HSPProgramID.system | uri | 1..1 |
| HealthcareService.identifier:sliceIdentifier-HSPProgramID.value | string | 1..1 |
| HealthcareService.identifier:sliceIdentifier-HSPProgramID.period | Period | 0..1 |
| HealthcareService.identifier:sliceIdentifier-HSPProgramID.assigner | Reference(Organization) | 0..1 |
| HealthcareService.identifier:sliceIdentifier-ConnexHealthProgramNumber | Identifier | 0..1 |
| HealthcareService.identifier:sliceIdentifier-ConnexHealthProgramNumber.id | string | 0..1 |
| HealthcareService.identifier:sliceIdentifier-ConnexHealthProgramNumber.extension | Extension | 0..* |
| HealthcareService.identifier:sliceIdentifier-ConnexHealthProgramNumber.use | code | 1..1 |
| HealthcareService.identifier:sliceIdentifier-ConnexHealthProgramNumber.type | CodeableConcept | 0..1 |
| HealthcareService.identifier:sliceIdentifier-ConnexHealthProgramNumber.system | uri | 1..1 |
| HealthcareService.identifier:sliceIdentifier-ConnexHealthProgramNumber.value | string | 1..1 |
| HealthcareService.identifier:sliceIdentifier-ConnexHealthProgramNumber.period | Period | 0..1 |
| HealthcareService.identifier:sliceIdentifier-ConnexHealthProgramNumber.assigner | Reference(Organization) | 0..1 |
| HealthcareService.active | boolean | 0..1 |
| HealthcareService.providedBy | Reference(Organization) | 0..1 |
| HealthcareService.category | CodeableConcept | 0..* |
| HealthcareService.type | CodeableConcept | 0..* |
| HealthcareService.specialty | CodeableConcept | 0..* |
| HealthcareService.location | Reference(LocationProfile) | 0..* |
| HealthcareService.name | string | 1..1 |
| HealthcareService.comment | string | 0..1 |
| HealthcareService.extraDetails | markdown | 0..1 |
| HealthcareService.photo | Attachment | 0..1 |
| HealthcareService.telecom | ContactPoint | 0..* |
| HealthcareService.coverageArea | Reference(Location) | 0..* |
| HealthcareService.serviceProvisionCode | CodeableConcept | 0..* |
| HealthcareService.eligibility | BackboneElement | 0..* |
| HealthcareService.eligibility.id | string | 0..1 |
| HealthcareService.eligibility.extension | Extension | 0..* |
| HealthcareService.eligibility.modifierExtension | Extension | 0..* |
| HealthcareService.eligibility.code | CodeableConcept | 0..1 |
| HealthcareService.eligibility.comment | markdown | 0..1 |
| HealthcareService.program | CodeableConcept | 0..* |
| HealthcareService.characteristic | CodeableConcept | 0..* |
| HealthcareService.communication | CodeableConcept | 0..* |
| HealthcareService.referralMethod | CodeableConcept | 0..* |
| HealthcareService.appointmentRequired | boolean | 0..1 |
| HealthcareService.availableTime | BackboneElement | 0..* |
| HealthcareService.availableTime.id | string | 0..1 |
| HealthcareService.availableTime.extension | Extension | 0..* |
| HealthcareService.availableTime.modifierExtension | Extension | 0..* |
| HealthcareService.availableTime.daysOfWeek | code | 0..* |
| HealthcareService.availableTime.allDay | boolean | 0..1 |
| HealthcareService.availableTime.availableStartTime | time | 0..1 |
| HealthcareService.availableTime.availableEndTime | time | 0..1 |
| HealthcareService.notAvailable | BackboneElement | 0..* |
| HealthcareService.notAvailable.id | string | 0..1 |
| HealthcareService.notAvailable.extension | Extension | 0..* |
| HealthcareService.notAvailable.modifierExtension | Extension | 0..* |
| HealthcareService.notAvailable.description | string | 1..1 |
| HealthcareService.notAvailable.during | Period | 0..1 |
| HealthcareService.availabilityExceptions | string | 0..1 |
| HealthcareService.endpoint | Reference(Endpoint) | 0..* |
JSON View
{
],
{
},
{
},
{
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
},
{
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
},
{
{
},
{
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
},
{
}
],
{
},
{
}
]
},
{
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
},
{
{
}
],
}
],
},
{
"definition": "The 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.",
},
],
"ele-1"
],
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"definition": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
]
},
{
"comment": "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](http.html#read) interaction.",
},
],
"ele-1"
],
{
}
],
]
},
{
"definition": "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) 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.",
"comment": "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. \n\nThis 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.",
},
],
"ele-1"
],
{
}
],
]
},
{
"definition": "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).",
"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.",
},
{
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
],
"fixedCanonical": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-healthcareservice",
"ele-1"
],
{
}
],
]
},
{
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
}
],
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Tags 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.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
}
],
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\".",
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
},
],
"ele-1"
],
{
}
],
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
]
},
{
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
},
],
"ele-1"
],
{
}
],
{
},
{
}
],
},
]
},
{
"definition": "A 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.",
"comment": "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.",
"narrative",
"html",
"xhtml",
"display"
],
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"inline resources",
"anonymous resources",
"contained resources"
],
},
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"comment": "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.",
"extensions",
"user content"
],
},
{
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-ext-functionalCentreCode"
]
}
],
"ele-1"
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"comment": "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.",
},
{
{
}
],
}
],
]
},
{
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
},
],
"ele-1"
],
{
}
],
"description": "The functional center code associated with the program/services supports provided to the client.",
},
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"comment": "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.\n\nThe cost center identifier associated with the program/services supports provided to the client . .",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "The 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.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "A 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).",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
{
}
],
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size\n\nThe cost center identifier associated with the program/services supports provided to the client . .",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"comment": "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.",
"requirements": "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.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"
}
]
},
{
{
}
],
"definition": "A 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.",
"requirements": "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.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
]
},
{
},
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
},
],
"ele-1"
],
{
}
],
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
{
}
],
},
{
},
{
},
{
}
]
},
{
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
}
],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
},
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements": "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.",
},
],
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "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](extension-rendered-value.html). 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.\n\nThe HSP program number that when used in combination with the HSP organization and site number uniquely identifes the service offering.",
},
],
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
},
{
}
]
},
{
"comment": "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\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
},
],
"ele-1"
],
{
},
{
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
}
],
{
},
{
},
{
"map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
},
{
},
{
}
]
},
{
"comment": "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.",
},
{
}
],
"ele-1"
],
{
},
{
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
}
],
{
},
{
},
{
},
{
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
}
]
},
{
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
},
],
"ele-1"
],
{
}
],
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
{
}
],
},
{
},
{
},
{
}
]
},
{
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
}
],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
},
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements": "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.",
},
],
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "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](extension-rendered-value.html). 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.",
},
],
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"comment": "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\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
},
],
"ele-1"
],
{
},
{
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
}
],
{
},
{
},
{
"map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
},
{
},
{
}
]
},
{
"comment": "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.",
},
{
}
],
"ele-1"
],
{
},
{
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
}
],
{
},
{
},
{
},
{
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
}
]
},
{
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
},
],
"ele-1"
],
{
}
],
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
{
}
],
},
{
},
{
},
{
}
]
},
{
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
}
],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
},
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements": "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.",
},
],
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "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](extension-rendered-value.html). 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.",
},
],
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"comment": "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\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
},
],
"ele-1"
],
{
},
{
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
}
],
{
},
{
},
{
"map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
},
{
},
{
}
]
},
{
"comment": "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.",
},
{
}
],
"ele-1"
],
{
},
{
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
}
],
{
},
{
},
{
},
{
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
}
]
},
{
"definition": "This 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.",
"comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
},
],
"meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element",
"ele-1"
],
{
}
],
"isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
{
},
{
},
{
}
]
},
{
"comment": "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.",
},
{
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-organization"
]
}
],
"ele-1"
],
{
},
{
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
}
],
{
},
{
},
{
}
]
},
{
"comment": "Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.",
"service category"
],
},
],
"ele-1"
],
{
}
],
{
}
],
},
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"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.",
"service type"
],
},
],
"ele-1"
],
{
}
],
{
}
],
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Collection of specialties handled by the service site. This is more of a medical term.",
"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.",
},
],
"ele-1"
],
{
}
],
{
}
],
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"comment": "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.",
},
{
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-location"
]
}
],
"ele-1"
],
{
},
{
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "Further description of the service as it would be presented to a consumer while searching.",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size\n\nThe name of program, as assigned by the HSP/Agency, provides information about the broad types of services received by clients.",
},
],
"ele-1"
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "Any 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.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
},
{
}
]
},
{
"comment": "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/",
},
],
"ele-1"
],
{
}
],
{
},
{
}
]
},
{
"definition": "If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.",
"comment": "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\".",
},
],
"ele-1"
],
{
},
{
}
],
{
},
{
},
{
},
{
}
]
},
{
},
],
"ele-1"
],
{
},
{
}
],
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "The location(s) that this service is available to (not where the service is provided).",
"comment": "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\".",
},
],
"ele-1"
],
{
},
{
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
}
],
{
},
{
},
{
}
]
},
{
"definition": "The code(s) that detail the conditions under which the healthcare service is available/offered.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
}
],
"description": "The code(s) that detail the conditions under which the healthcare service is available/offered.",
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Does this service have specific eligibility requirements that need to be met in order to use the service?",
},
],
"ele-1"
],
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
"ele-1"
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
"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.",
},
],
"ele-1"
],
{
}
],
{
}
],
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
},
{
}
]
},
{
"comment": "Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….",
},
],
"ele-1"
],
{
}
],
{
}
],
},
{
},
{
},
{
},
{
},
{
}
]
},
{
},
],
"ele-1"
],
{
}
],
{
}
],
"description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy)."
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Some 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.",
"comment": "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.",
},
],
"ele-1"
],
{
}
],
{
},
{
}
],
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.",
"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.",
},
],
"ele-1"
],
{
}
],
{
}
],
"description": "The methods of referral can be used when referring to a specific HealthCareService resource.",
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Indicates 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.",
},
],
"ele-1"
],
{
}
],
{
},
{
}
]
},
{
"comment": "More detailed availability information may be provided in associated Schedule/Slot resources.",
},
],
"ele-1"
],
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
"ele-1"
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
},
],
"ele-1"
],
{
}
],
{
}
],
},
]
},
{
},
],
"ele-1"
],
{
}
],
]
},
{
"definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
},
],
"ele-1"
],
{
}
],
]
},
{
"definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
},
],
"ele-1"
],
{
}
],
]
},
{
"definition": "The HealthcareService is not available during this period of time due to the provided reason.",
},
],
"ele-1"
],
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May 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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
"ele-1"
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
},
],
"ele-1"
],
{
}
],
]
},
{
"comment": "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\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
},
],
"ele-1"
],
{
},
{
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
}
],
{
},
{
},
{
"map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
}
]
},
{
"definition": "A 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.",
},
],
"ele-1"
],
{
}
],
]
},
{
"short": "Technical endpoints providing access to electronic services operated for the healthcare service",
"definition": "Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.",
"comment": "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.",
},
],
"ele-1"
],
{
},
{
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
}
],
{
},
{
}
]
}
]
},
{
},
{
},
{
"fixedCanonical": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-healthcareservice",
},
{
},
{
{
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-ext-functionalCentreCode"
]
}
],
},
{
}
},
{
},
},
{
},
{
"comment": "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](extension-rendered-value.html). 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.\n\nThe HSP program number that when used in combination with the HSP organization and site number uniquely identifes the service offering.",
]
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
{
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-organization"
]
}
],
},
{
{
"http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-location"
]
}
],
},
{
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size\n\nThe name of program, as assigned by the HSP/Agency, provides information about the broad types of services received by clients.",
]
}
]
}
}
Usage
The HealthcareService Resource is used to share information pertainining to a program that a client is enrolled in at an organization from which they are receiving care. Healthcare service data is collected at the functional centre level, and can be further elaborated through ConnexOntario program information.
Notes
meta.profile
- used to declare conformance to this profile
- populate with a fixed value:
http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-healthcareservice|2.0.0
extension(functionalCentreCode)
- SHALL contain the cost center identifier linked to client program/service support, Functional Centres are maintained by Ministry of Health Ontario Healthcare Reporting Standards (OHRS) to record financial information for healthcare organizations, including revenues, expenses, and statistics related to specific functions. This field also captures Children and Youth Mental Health 'A codes' for core services and key processes.
.identifier
- SHALL contain the unique program number/ ID created by HSP to identify the program within the organization
- SHOULD also contain the unique program number assigned by ConnexOntario to identify the program within an HSP, if applicable
.name
- SHALL contain the name of program, this is the designated title assigned to a specific health program, providing a concise means of recognition and communication about the services being delivered