Extensions for Using Data Elements from FHIR R4 in FHIR R5
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4 in FHIR R5
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4 in FHIR R5 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-HealthcareService | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R4_HealthcareService_R5 | ||
This cross-version profile allows R4 HealthcareService content to be represented via FHIR R5 HealthcareService resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  HealthcareService |
0..* | HealthcareService(5.0.0) | The details of a healthcare service available at a location | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:telecom |
0..* | ContactPoint | R4: Contacts related to the healthcare service (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.telecom Constraints: ext-1 | |
 extension:availabilityExceptions |
0..1 | string | R4: Description of availability exceptions (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availabilityExceptions Constraints: ext-1 | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
 active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | HealthcareService.implicitRules, HealthcareService.extension, HealthcareService.extension:telecom, HealthcareService.extension:availabilityExceptions, HealthcareService.modifierExtension, HealthcareService.active | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | HealthcareService.extension, HealthcareService.extension:telecom, HealthcareService.extension:availabilityExceptions, HealthcareService.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService(5.0.0) | The details of a healthcare service available at a location | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:telecom |
0..* | ContactPoint | R4: Contacts related to the healthcare service (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.telecom Constraints: ext-1 | |||||
| extension:availabilityExceptions |
0..1 | string | R4: Description of availability exceptions (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availabilityExceptions Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | External identifiers for this item | ||||
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
 providedBy |
Σ | 0..1 | Reference(Organization) | Organization that provides this service | ||||
| offeredIn |
0..* | Reference(HealthcareService) | The service within which this service is offered | |||||
| category |
Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
| type |
Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | ||||
| specialty |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | ||||
| location |
Σ | 0..* | Reference(Location) | Location(s) where service may be provided | ||||
| name |
Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment |
Σ | 0..1 | markdown | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo |
Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
| contact |
0..* | ExtendedContactDetail | Official contact details for the HealthcareService | |||||
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode |
0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||
| eligibility |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
| comment |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility). | |||||
| communication |
0..* | CodeableConcept | The language that this service is offered in Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| referralMethod |
0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthcareService resource. | |||||
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |||||
| availability |
0..* | Availability | Times the healthcare service is available (including exceptions) | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:daysOfWeek |
0..* | code | R4: mon | tue | wed | thu | fri | sat | sun additional types URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availableTime.daysOfWeek Binding: DaysOfWeek (required): The days of the week. Constraints: ext-1 | |||||
| extension:allDay |
0..1 | boolean | R4: Always available? e.g. 24 hour service (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availableTime.allDay Constraints: ext-1 | |||||
| extension:availableStartTime |
0..1 | time | R4: Opening time of day (ignored if allDay = true) (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availableTime.availableStartTime Constraints: ext-1 | |||||
| extension:availableEndTime |
0..1 | time | R4: Closing time of day (ignored if allDay = true) (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availableTime.availableEndTime Constraints: ext-1 | |||||
| extension:description |
1..1 | string | R4: Reason presented to the user explaining why time not available additional types URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.notAvailable.description Constraints: ext-1 | |||||
| extension:during |
0..1 | Period | R4: Service not available from this date (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.notAvailable.during Constraints: ext-1 | |||||
| availableTime |
ΣC | 0..* | Element | Times the {item} is available Constraints: av-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| daysOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The purpose for which an extended contact detail should be used. | ||||
| allDay |
ΣC | 0..1 | boolean | Always available? i.e. 24 hour service | ||||
| availableStartTime |
ΣC | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
| availableEndTime |
ΣC | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
 notAvailableTime |
Σ | 0..* | Element | Not available during this time due to provided reason | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| description |
Σ | 0..1 | string | Reason presented to the user explaining why time not available | ||||
| during |
Σ | 0..1 | Period | Service not available during this period | ||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| HealthcareService.category | Base | example | Service Category | 📍5.0.0 | FHIR Std. |
| HealthcareService.type | Base | example | Service Type | 📍5.0.0 | FHIR Std. |
| HealthcareService.specialty | Base | preferred | Practice Setting Code Value Set | 📍5.0.0 | FHIR Std. |
| HealthcareService.serviceProvisionCode | Base | example | Service Provision Conditions | 📍5.0.0 | FHIR Std. |
| HealthcareService.eligibility.code | Base | example | Not State | Unknown | |
| HealthcareService.program | Base | example | Program | 📍5.0.0 | FHIR Std. |
| HealthcareService.characteristic | Base | example | Service Mode | 📍5.0.0 | FHIR Std. |
| HealthcareService.communication | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| HealthcareService.referralMethod | Base | example | Referral Method | 📍5.0.0 | FHIR Std. |
| HealthcareService.availability.availableTime.daysOfWeek | Base | required | Days Of Week | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| av-1 | error | HealthcareService.availability.availableTime | Cannot include start/end times when selecting all day availability. |
allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not())
|
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | HealthcareService.meta, HealthcareService.implicitRules, HealthcareService.language, HealthcareService.text, HealthcareService.extension, HealthcareService.extension:telecom, HealthcareService.extension:availabilityExceptions, HealthcareService.modifierExtension, HealthcareService.identifier, HealthcareService.active, HealthcareService.providedBy, HealthcareService.offeredIn, HealthcareService.category, HealthcareService.type, HealthcareService.specialty, HealthcareService.location, HealthcareService.name, HealthcareService.comment, HealthcareService.extraDetails, HealthcareService.photo, HealthcareService.contact, HealthcareService.coverageArea, HealthcareService.serviceProvisionCode, HealthcareService.eligibility, HealthcareService.eligibility.extension, HealthcareService.eligibility.modifierExtension, HealthcareService.eligibility.code, HealthcareService.eligibility.comment, HealthcareService.program, HealthcareService.characteristic, HealthcareService.communication, HealthcareService.referralMethod, HealthcareService.appointmentRequired, HealthcareService.availability, HealthcareService.availability.extension, HealthcareService.availability.extension:daysOfWeek, HealthcareService.availability.extension:allDay, HealthcareService.availability.extension:availableStartTime, HealthcareService.availability.extension:availableEndTime, HealthcareService.availability.extension:description, HealthcareService.availability.extension:during, HealthcareService.availability.availableTime, HealthcareService.availability.availableTime.extension, HealthcareService.availability.availableTime.daysOfWeek, HealthcareService.availability.availableTime.allDay, HealthcareService.availability.availableTime.availableStartTime, HealthcareService.availability.availableTime.availableEndTime, HealthcareService.availability.notAvailableTime, HealthcareService.availability.notAvailableTime.extension, HealthcareService.availability.notAvailableTime.description, HealthcareService.availability.notAvailableTime.during, HealthcareService.endpoint | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | HealthcareService.extension, HealthcareService.extension:telecom, HealthcareService.extension:availabilityExceptions, HealthcareService.modifierExtension, HealthcareService.eligibility.extension, HealthcareService.eligibility.modifierExtension, HealthcareService.availability.extension, HealthcareService.availability.extension:daysOfWeek, HealthcareService.availability.extension:allDay, HealthcareService.availability.extension:availableStartTime, HealthcareService.availability.extension:availableEndTime, HealthcareService.availability.extension:description, HealthcareService.availability.extension:during, HealthcareService.availability.availableTime.extension, HealthcareService.availability.notAvailableTime.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService(5.0.0) | The details of a healthcare service available at a location | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:telecom |
0..* | ContactPoint | R4: Contacts related to the healthcare service (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.telecom Constraints: ext-1 | |
| extension:availabilityExceptions |
0..1 | string | R4: Description of availability exceptions (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availabilityExceptions Constraints: ext-1 | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | HealthcareService.implicitRules, HealthcareService.extension, HealthcareService.extension:telecom, HealthcareService.extension:availabilityExceptions, HealthcareService.modifierExtension, HealthcareService.active | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | HealthcareService.extension, HealthcareService.extension:telecom, HealthcareService.extension:availabilityExceptions, HealthcareService.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from HealthcareService
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService(5.0.0) | The details of a healthcare service available at a location | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:telecom |
0..* | ContactPoint | R4: Contacts related to the healthcare service (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.telecom Constraints: ext-1 | |||||
| extension:availabilityExceptions |
0..1 | string | R4: Description of availability exceptions (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availabilityExceptions Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | External identifiers for this item | ||||
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
| providedBy |
Σ | 0..1 | Reference(Organization) | Organization that provides this service | ||||
| offeredIn |
0..* | Reference(HealthcareService) | The service within which this service is offered | |||||
| category |
Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
| type |
Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | ||||
| specialty |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | ||||
| location |
Σ | 0..* | Reference(Location) | Location(s) where service may be provided | ||||
| name |
Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment |
Σ | 0..1 | markdown | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo |
Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
| contact |
0..* | ExtendedContactDetail | Official contact details for the HealthcareService | |||||
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode |
0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||
| eligibility |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
| comment |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility). | |||||
| communication |
0..* | CodeableConcept | The language that this service is offered in Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| referralMethod |
0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthcareService resource. | |||||
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |||||
| availability |
0..* | Availability | Times the healthcare service is available (including exceptions) | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:daysOfWeek |
0..* | code | R4: mon | tue | wed | thu | fri | sat | sun additional types URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availableTime.daysOfWeek Binding: DaysOfWeek (required): The days of the week. Constraints: ext-1 | |||||
| extension:allDay |
0..1 | boolean | R4: Always available? e.g. 24 hour service (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availableTime.allDay Constraints: ext-1 | |||||
| extension:availableStartTime |
0..1 | time | R4: Opening time of day (ignored if allDay = true) (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availableTime.availableStartTime Constraints: ext-1 | |||||
| extension:availableEndTime |
0..1 | time | R4: Closing time of day (ignored if allDay = true) (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.availableTime.availableEndTime Constraints: ext-1 | |||||
| extension:description |
1..1 | string | R4: Reason presented to the user explaining why time not available additional types URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.notAvailable.description Constraints: ext-1 | |||||
| extension:during |
0..1 | Period | R4: Service not available from this date (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-HealthcareService.notAvailable.during Constraints: ext-1 | |||||
| availableTime |
ΣC | 0..* | Element | Times the {item} is available Constraints: av-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| daysOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The purpose for which an extended contact detail should be used. | ||||
| allDay |
ΣC | 0..1 | boolean | Always available? i.e. 24 hour service | ||||
| availableStartTime |
ΣC | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
| availableEndTime |
ΣC | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
| notAvailableTime |
Σ | 0..* | Element | Not available during this time due to provided reason | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| description |
Σ | 0..1 | string | Reason presented to the user explaining why time not available | ||||
| during |
Σ | 0..1 | Period | Service not available during this period | ||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| HealthcareService.category | Base | example | Service Category | 📍5.0.0 | FHIR Std. |
| HealthcareService.type | Base | example | Service Type | 📍5.0.0 | FHIR Std. |
| HealthcareService.specialty | Base | preferred | Practice Setting Code Value Set | 📍5.0.0 | FHIR Std. |
| HealthcareService.serviceProvisionCode | Base | example | Service Provision Conditions | 📍5.0.0 | FHIR Std. |
| HealthcareService.eligibility.code | Base | example | Not State | Unknown | |
| HealthcareService.program | Base | example | Program | 📍5.0.0 | FHIR Std. |
| HealthcareService.characteristic | Base | example | Service Mode | 📍5.0.0 | FHIR Std. |
| HealthcareService.communication | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| HealthcareService.referralMethod | Base | example | Referral Method | 📍5.0.0 | FHIR Std. |
| HealthcareService.availability.availableTime.daysOfWeek | Base | required | Days Of Week | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| av-1 | error | HealthcareService.availability.availableTime | Cannot include start/end times when selecting all day availability. |
allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not())
|
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | HealthcareService.meta, HealthcareService.implicitRules, HealthcareService.language, HealthcareService.text, HealthcareService.extension, HealthcareService.extension:telecom, HealthcareService.extension:availabilityExceptions, HealthcareService.modifierExtension, HealthcareService.identifier, HealthcareService.active, HealthcareService.providedBy, HealthcareService.offeredIn, HealthcareService.category, HealthcareService.type, HealthcareService.specialty, HealthcareService.location, HealthcareService.name, HealthcareService.comment, HealthcareService.extraDetails, HealthcareService.photo, HealthcareService.contact, HealthcareService.coverageArea, HealthcareService.serviceProvisionCode, HealthcareService.eligibility, HealthcareService.eligibility.extension, HealthcareService.eligibility.modifierExtension, HealthcareService.eligibility.code, HealthcareService.eligibility.comment, HealthcareService.program, HealthcareService.characteristic, HealthcareService.communication, HealthcareService.referralMethod, HealthcareService.appointmentRequired, HealthcareService.availability, HealthcareService.availability.extension, HealthcareService.availability.extension:daysOfWeek, HealthcareService.availability.extension:allDay, HealthcareService.availability.extension:availableStartTime, HealthcareService.availability.extension:availableEndTime, HealthcareService.availability.extension:description, HealthcareService.availability.extension:during, HealthcareService.availability.availableTime, HealthcareService.availability.availableTime.extension, HealthcareService.availability.availableTime.daysOfWeek, HealthcareService.availability.availableTime.allDay, HealthcareService.availability.availableTime.availableStartTime, HealthcareService.availability.availableTime.availableEndTime, HealthcareService.availability.notAvailableTime, HealthcareService.availability.notAvailableTime.extension, HealthcareService.availability.notAvailableTime.description, HealthcareService.availability.notAvailableTime.during, HealthcareService.endpoint | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | HealthcareService.extension, HealthcareService.extension:telecom, HealthcareService.extension:availabilityExceptions, HealthcareService.modifierExtension, HealthcareService.eligibility.extension, HealthcareService.eligibility.modifierExtension, HealthcareService.availability.extension, HealthcareService.availability.extension:daysOfWeek, HealthcareService.availability.extension:allDay, HealthcareService.availability.extension:availableStartTime, HealthcareService.availability.extension:availableEndTime, HealthcareService.availability.extension:description, HealthcareService.availability.extension:during, HealthcareService.availability.availableTime.extension, HealthcareService.availability.notAvailableTime.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r4.r5#0.1.0 based on FHIR 5.0.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
