WOF Connect📍, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-connect/ and changes regularly. See the Directory of published versions
| Official URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-healthcareservice | Version: 0.1.1 | |||
| Active as of 2026-03-06 | Computable Name: WofConnectHealthcareService | |||
HealthcareServicePortal represents the place and operational context where care is performed.
It answers the question: 'Where can the patient receive a service?'
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: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() |
SOΣ | 1..1 | id | logical id for Wof Connect HealthcareService
| ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | System the data originates from | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
S | 0..* | Location | Resources contained within the healthcare service resource | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SOΣ | 1..* | Identifier | Identifier for the healthcare service Slice: Unordered, Open by value:system
| ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | System that issued the identifier (e.g. hospital, government) Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Value of the identifier Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External identifiers for this item | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The source system. Shall correspond with meta.tag where system = http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Value of the identifier Example General: 123456 | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
![]() ![]() |
SOΣ | 1..1 | Reference(Organization) | Organization that provides the healthcare service
| ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name of the organization that provides the healthcare service | ||||
![]() ![]() |
SOΣ | 1..* | Reference(Location) | Location where the healthcare service is provided
| ||||
![]() ![]() |
SOΣ | 1..1 | string | Name of the healthcare service
| ||||
![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() |
S | 0..* | CodeableConcept | Collection of characteristics (attributes) Slice: Unordered, Open by pattern:coding.system Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Coded characteristic of the healthcare service | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | System that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Code that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Display text for the coded characteristic | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Coded schedule characteristic of the healthcare service | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier:businessIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | example | Not State | Unknown | |
| HealthcareService.characteristic:codeCharacteristic | Base | example | Not State | Unknown | |
| HealthcareService.characteristic:scheduleCharacteristic | Base | example | Not State | Unknown |
| 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().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()
|
| 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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() |
SO | 1..1 | id | logical id for Wof Connect HealthcareService
| ||||
![]() ![]() |
||||||||
![]() ![]() ![]() |
S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
1..* | Coding | Tags applied to this resource | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | System the data originates from | ||||
![]() ![]() |
S | 0..* | Location | Resources contained within the healthcare service resource | ||||
![]() ![]() |
SO | 1..* | Identifier | Identifier for the healthcare service Slice: Unordered, Open by value:system
| ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | System that issued the identifier (e.g. hospital, government) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Value of the identifier | ||||
![]() ![]() ![]() |
S | 1..1 | Identifier | External identifiers for this item | ||||
![]() ![]() ![]() ![]() |
||||||||
![]() ![]() ![]() ![]() ![]() |
||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: RI | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The source system. Shall correspond with meta.tag where system = http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system | |||||
![]() ![]() |
SO | 1..1 | Reference(Organization) | Organization that provides the healthcare service
| ||||
![]() ![]() ![]() |
S | 1..1 | string | Name of the organization that provides the healthcare service | ||||
![]() ![]() |
SO | 1..* | Reference(Location) | Location where the healthcare service is provided
| ||||
![]() ![]() |
SO | 1..1 | string | Name of the healthcare service
| ||||
![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |||||
![]() ![]() |
S | 0..* | CodeableConcept | Collection of characteristics (attributes) Slice: Unordered, Open by pattern:coding.system | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Coded characteristic of the healthcare service | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | System that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Code that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Display text for the coded characteristic | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) | ||||
![]() ![]() ![]() ![]() |
1..* | Coding | Coded schedule characteristic of the healthcare service | |||||
Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() |
SOΣ | 1..1 | id | logical id for Wof Connect HealthcareService
| ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | System the data originates from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
S | 0..* | Location | Resources contained within the healthcare service resource | ||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SOΣ | 1..* | Identifier | Identifier for the healthcare service Slice: Unordered, Open by value:system
| ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | System that issued the identifier (e.g. hospital, government) Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Value of the identifier Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External identifiers for this item | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: RI | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The source system. Shall correspond with meta.tag where system = http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Value of the identifier Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
![]() ![]() |
SOΣ | 1..1 | Reference(Organization) | Organization that provides the healthcare service
| ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name of the organization that provides the healthcare service | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
![]() ![]() |
Σ | 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). | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | ||||
![]() ![]() |
SOΣ | 1..* | Reference(Location) | Location where the healthcare service is provided
| ||||
![]() ![]() |
SOΣ | 1..1 | string | Name of the healthcare service
| ||||
![]() ![]() |
Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
![]() ![]() |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
![]() ![]() |
Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
![]() ![]() |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
![]() ![]() |
S | 0..* | CodeableConcept | Collection of characteristics (attributes) Slice: Unordered, Open by pattern:coding.system Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Coded characteristic of the healthcare service | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | System that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Code that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Display text for the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Coded schedule characteristic of the healthcare service | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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. | |||||
![]() ![]() |
0..1 | boolean | If an appointment is required for access to this service | |||||
![]() ![]() |
0..* | BackboneElement | Times the Service Site is available | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
![]() ![]() ![]() |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
![]() ![]() ![]() |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
![]() ![]() |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | |||||
![]() ![]() ![]() |
0..1 | Period | Service not available from this date | |||||
![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() |
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.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| HealthcareService.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| HealthcareService.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier:businessIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier:businessIdentifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| HealthcareService.providedBy.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.type | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| HealthcareService.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.serviceProvisionCode | Base | example | ServiceProvisionConditions | 📍4.0.1 | FHIR Std. |
| HealthcareService.eligibility.code | Base | example | Not State | Unknown | |
| HealthcareService.program | Base | example | Program | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | example | Not State | Unknown | |
| HealthcareService.characteristic:codeCharacteristic | Base | example | Not State | Unknown | |
| HealthcareService.characteristic:scheduleCharacteristic | Base | example | Not State | Unknown | |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.referralMethod | Base | example | ReferralMethod | 📍4.0.1 | FHIR Std. |
| HealthcareService.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| 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().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()
|
| 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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
Summary
Mandatory: 9 elements(11 nested mandatory elements)
Must-Support: 23 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() |
SOΣ | 1..1 | id | logical id for Wof Connect HealthcareService
| ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | System the data originates from | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
S | 0..* | Location | Resources contained within the healthcare service resource | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SOΣ | 1..* | Identifier | Identifier for the healthcare service Slice: Unordered, Open by value:system
| ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | System that issued the identifier (e.g. hospital, government) Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Value of the identifier Example General: 123456 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External identifiers for this item | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The source system. Shall correspond with meta.tag where system = http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Value of the identifier Example General: 123456 | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
![]() ![]() |
SOΣ | 1..1 | Reference(Organization) | Organization that provides the healthcare service
| ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name of the organization that provides the healthcare service | ||||
![]() ![]() |
SOΣ | 1..* | Reference(Location) | Location where the healthcare service is provided
| ||||
![]() ![]() |
SOΣ | 1..1 | string | Name of the healthcare service
| ||||
![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() |
S | 0..* | CodeableConcept | Collection of characteristics (attributes) Slice: Unordered, Open by pattern:coding.system Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Coded characteristic of the healthcare service | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | System that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Code that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Display text for the coded characteristic | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Coded schedule characteristic of the healthcare service | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier:businessIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | example | Not State | Unknown | |
| HealthcareService.characteristic:codeCharacteristic | Base | example | Not State | Unknown | |
| HealthcareService.characteristic:scheduleCharacteristic | Base | example | Not State | Unknown |
| 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().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()
|
| 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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() |
SO | 1..1 | id | logical id for Wof Connect HealthcareService
| ||||
![]() ![]() |
||||||||
![]() ![]() ![]() |
S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
1..* | Coding | Tags applied to this resource | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | System the data originates from | ||||
![]() ![]() |
S | 0..* | Location | Resources contained within the healthcare service resource | ||||
![]() ![]() |
SO | 1..* | Identifier | Identifier for the healthcare service Slice: Unordered, Open by value:system
| ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | System that issued the identifier (e.g. hospital, government) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Value of the identifier | ||||
![]() ![]() ![]() |
S | 1..1 | Identifier | External identifiers for this item | ||||
![]() ![]() ![]() ![]() |
||||||||
![]() ![]() ![]() ![]() ![]() |
||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: RI | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The source system. Shall correspond with meta.tag where system = http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system | |||||
![]() ![]() |
SO | 1..1 | Reference(Organization) | Organization that provides the healthcare service
| ||||
![]() ![]() ![]() |
S | 1..1 | string | Name of the organization that provides the healthcare service | ||||
![]() ![]() |
SO | 1..* | Reference(Location) | Location where the healthcare service is provided
| ||||
![]() ![]() |
SO | 1..1 | string | Name of the healthcare service
| ||||
![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |||||
![]() ![]() |
S | 0..* | CodeableConcept | Collection of characteristics (attributes) Slice: Unordered, Open by pattern:coding.system | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Coded characteristic of the healthcare service | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | System that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Code that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Display text for the coded characteristic | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) | ||||
![]() ![]() ![]() ![]() |
1..* | Coding | Coded schedule characteristic of the healthcare service | |||||
Documentation for this format | ||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() |
SOΣ | 1..1 | id | logical id for Wof Connect HealthcareService
| ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | System the data originates from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
S | 0..* | Location | Resources contained within the healthcare service resource | ||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SOΣ | 1..* | Identifier | Identifier for the healthcare service Slice: Unordered, Open by value:system
| ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | System that issued the identifier (e.g. hospital, government) Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Value of the identifier Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External identifiers for this item | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: RI | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The source system. Shall correspond with meta.tag where system = http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Value of the identifier Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
![]() ![]() |
SOΣ | 1..1 | Reference(Organization) | Organization that provides the healthcare service
| ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name of the organization that provides the healthcare service | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
![]() ![]() |
Σ | 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). | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | ||||
![]() ![]() |
SOΣ | 1..* | Reference(Location) | Location where the healthcare service is provided
| ||||
![]() ![]() |
SOΣ | 1..1 | string | Name of the healthcare service
| ||||
![]() ![]() |
Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
![]() ![]() |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
![]() ![]() |
Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..1 | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
![]() ![]() |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
![]() ![]() |
S | 0..* | CodeableConcept | Collection of characteristics (attributes) Slice: Unordered, Open by pattern:coding.system Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Coded characteristic of the healthcare service | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | System that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Code that defines the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Display text for the coded characteristic | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Coded schedule characteristic of the healthcare service | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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. | |||||
![]() ![]() |
0..1 | boolean | If an appointment is required for access to this service | |||||
![]() ![]() |
0..* | BackboneElement | Times the Service Site is available | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
![]() ![]() ![]() |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
![]() ![]() ![]() |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
![]() ![]() |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | |||||
![]() ![]() ![]() |
0..1 | Period | Service not available from this date | |||||
![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() |
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.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| HealthcareService.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| HealthcareService.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier:businessIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier:businessIdentifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| HealthcareService.providedBy.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.type | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| HealthcareService.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| HealthcareService.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.serviceProvisionCode | Base | example | ServiceProvisionConditions | 📍4.0.1 | FHIR Std. |
| HealthcareService.eligibility.code | Base | example | Not State | Unknown | |
| HealthcareService.program | Base | example | Program | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | example | Not State | Unknown | |
| HealthcareService.characteristic:codeCharacteristic | Base | example | Not State | Unknown | |
| HealthcareService.characteristic:scheduleCharacteristic | Base | example | Not State | Unknown | |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.referralMethod | Base | example | ReferralMethod | 📍4.0.1 | FHIR Std. |
| HealthcareService.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| 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().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()
|
| 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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
Summary
Mandatory: 9 elements(11 nested mandatory elements)
Must-Support: 23 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron