FHIR Core Implementation Guide (CO)
0.1.0 - STU1
FHIR Core Implementation Guide (CO) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://co.fhir.guide/core/StructureDefinition/HealthcareServiceCO | Version: 0.1.0 | |||
Draft as of 2024-11-19 | Computable Name: HealthcareServiceCO | |||
Copyright/Legal: HL7 Colombia, CC-BY-4.0, 2024+ |
FHIR HealthcareService colombian Core profile, defined by HL7 CO.
Record and track information from an authorized health service at a point of care (location) of a care delivery organization or institution.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from HealthcareService
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | 0..* | HealthcareService | Closing time of day (ignored if allDay = true) | |
meta | ||||
profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/HealthcareServiceCO | |
identifier | 1..* | Identifier | Healthcare service identifier (DHSS) | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
system | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS | |
value | 1..1 | string | Healthcare Services Qualification Distinctive | |
active | S | 1..1 | boolean | true | false |
providedBy | S | 1..1 | Reference(Profile: Care Delivery Organization CO) | Reference to organization resource. |
category | S | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes (required) |
type | S | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes (required) |
specialty | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred) | |
location | S | 0..* | Reference(Profile: Care Delivery Location CO) | Location(s) where service may be provided |
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
value | 1..1 | string | Syntax: +57(000)000-0000 | |
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
value | 1..1 | string | Syntax: (000)000-0000 | |
use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile | |
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
value | 1..1 | string | Syntax: info@example.com | |
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: url | |
value | 1..1 | string | Syntax: http://example.com | |
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) |
availableTime | 0..* | BackboneElement | Times the Service Site is available | |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HealthcareService.category | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes | |
HealthcareService.type | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes | |
HealthcareService.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | 0..* | HealthcareService | Closing time of day (ignored if allDay = true) | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | Healthcare service identifier (DHSS) |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS |
value | Σ | 1..1 | string | Healthcare Services Qualification Distinctive Example General: 123456 |
active | ?!SΣ | 1..1 | boolean | true | false |
providedBy | SΣ | 1..1 | Reference(Profile: Care Delivery Organization CO) | Reference to organization resource. |
category | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes (required) |
type | SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes (required) |
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred) |
location | SΣ | 0..* | Reference(Profile: Care Delivery Location CO) | Location(s) where service may be provided |
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
value | Σ | 1..1 | string | Syntax: +57(000)000-0000 |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
value | Σ | 1..1 | string | Syntax: (000)000-0000 |
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile |
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
value | Σ | 1..1 | string | Syntax: info@example.com |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url |
value | Σ | 1..1 | string | Syntax: http://example.com |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description (No ValueSet): (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). |
availableTime | 0..* | BackboneElement | Times the Service Site is available | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
HealthcareService.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
HealthcareService.category | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes | |
HealthcareService.type | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes | |
HealthcareService.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
HealthcareService.telecom:TelecomPhone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomPhone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomMobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomMobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomEmail.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomEmail.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomURL.system | required | Fixed Value: urlhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomURL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
HealthcareService.characteristic | example | ||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
HealthcareService | 0..* | HealthcareService | Closing time of day (ignored if allDay = true) | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/HealthcareServiceCO | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | 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". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Healthcare service identifier (DHSS) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
type | Σ | 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. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS | ||||
value | Σ | 1..1 | string | Healthcare Services Qualification Distinctive Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!SΣ | 1..1 | boolean | true | false | ||||
providedBy | SΣ | 1..1 | Reference(Profile: Care Delivery Organization CO) | Reference to organization resource. | ||||
category | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes (required) | ||||
type | SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes (required) | ||||
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred) | ||||
location | SΣ | 0..* | Reference(Profile: Care Delivery Location CO) | Location(s) where service may be provided | ||||
name | Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
comment | Σ | 0..1 | string | 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 | ||||
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |||||
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 1..1 | string | Syntax: +57(000)000-0000 | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 1..1 | string | Syntax: (000)000-0000 | ||||
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
value | Σ | 1..1 | string | Syntax: info@example.com | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url | ||||
value | Σ | 1..1 | string | Syntax: http://example.com | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Coded value for the eligibility Binding Description (No ValueSet): (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 | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description (No ValueSet): (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
communication | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): 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 | |||||
availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |||||
allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
notAvailable | 0..* | BackboneElement | 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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
during | 0..1 | Period | Service not available from this date | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
HealthcareService.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
HealthcareService.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
HealthcareService.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
HealthcareService.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
HealthcareService.category | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes | ||||
HealthcareService.type | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes | ||||
HealthcareService.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
HealthcareService.telecom:TelecomPhone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomPhone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomMobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomMobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomEmail.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomEmail.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomURL.system | required | Fixed Value: urlhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomURL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditionshttp://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard | ||||
HealthcareService.eligibility.code | example | |||||
HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/program from the FHIR Standard | ||||
HealthcareService.characteristic | example | |||||
HealthcareService.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard | ||||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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: 5 elements(13 nested mandatory elements)
Must-Support: 6 elements
Fixed: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from HealthcareService
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | 0..* | HealthcareService | Closing time of day (ignored if allDay = true) | |
meta | ||||
profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/HealthcareServiceCO | |
identifier | 1..* | Identifier | Healthcare service identifier (DHSS) | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
system | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS | |
value | 1..1 | string | Healthcare Services Qualification Distinctive | |
active | S | 1..1 | boolean | true | false |
providedBy | S | 1..1 | Reference(Profile: Care Delivery Organization CO) | Reference to organization resource. |
category | S | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes (required) |
type | S | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes (required) |
specialty | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred) | |
location | S | 0..* | Reference(Profile: Care Delivery Location CO) | Location(s) where service may be provided |
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
value | 1..1 | string | Syntax: +57(000)000-0000 | |
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
value | 1..1 | string | Syntax: (000)000-0000 | |
use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile | |
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
value | 1..1 | string | Syntax: info@example.com | |
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: url | |
value | 1..1 | string | Syntax: http://example.com | |
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) |
availableTime | 0..* | BackboneElement | Times the Service Site is available | |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HealthcareService.category | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes | |
HealthcareService.type | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes | |
HealthcareService.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | 0..* | HealthcareService | Closing time of day (ignored if allDay = true) | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | Healthcare service identifier (DHSS) |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS |
value | Σ | 1..1 | string | Healthcare Services Qualification Distinctive Example General: 123456 |
active | ?!SΣ | 1..1 | boolean | true | false |
providedBy | SΣ | 1..1 | Reference(Profile: Care Delivery Organization CO) | Reference to organization resource. |
category | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes (required) |
type | SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes (required) |
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred) |
location | SΣ | 0..* | Reference(Profile: Care Delivery Location CO) | Location(s) where service may be provided |
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
value | Σ | 1..1 | string | Syntax: +57(000)000-0000 |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
value | Σ | 1..1 | string | Syntax: (000)000-0000 |
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile |
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
value | Σ | 1..1 | string | Syntax: info@example.com |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url |
value | Σ | 1..1 | string | Syntax: http://example.com |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description (No ValueSet): (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). |
availableTime | 0..* | BackboneElement | Times the Service Site is available | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
HealthcareService.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
HealthcareService.category | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes | |
HealthcareService.type | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes | |
HealthcareService.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
HealthcareService.telecom:TelecomPhone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomPhone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomMobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomMobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomEmail.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomEmail.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomURL.system | required | Fixed Value: urlhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
HealthcareService.telecom:TelecomURL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
HealthcareService.characteristic | example | ||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
HealthcareService | 0..* | HealthcareService | Closing time of day (ignored if allDay = true) | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/HealthcareServiceCO | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | 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". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Healthcare service identifier (DHSS) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
type | Σ | 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. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS | ||||
value | Σ | 1..1 | string | Healthcare Services Qualification Distinctive Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!SΣ | 1..1 | boolean | true | false | ||||
providedBy | SΣ | 1..1 | Reference(Profile: Care Delivery Organization CO) | Reference to organization resource. | ||||
category | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes (required) | ||||
type | SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes (required) | ||||
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred) | ||||
location | SΣ | 0..* | Reference(Profile: Care Delivery Location CO) | Location(s) where service may be provided | ||||
name | Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
comment | Σ | 0..1 | string | 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 | ||||
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |||||
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 1..1 | string | Syntax: +57(000)000-0000 | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 1..1 | string | Syntax: (000)000-0000 | ||||
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
value | Σ | 1..1 | string | Syntax: info@example.com | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url | ||||
value | Σ | 1..1 | string | Syntax: http://example.com | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Coded value for the eligibility Binding Description (No ValueSet): (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 | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description (No ValueSet): (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
communication | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): 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 | |||||
availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |||||
allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
notAvailable | 0..* | BackboneElement | 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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
during | 0..1 | Period | Service not available from this date | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
HealthcareService.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
HealthcareService.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
HealthcareService.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
HealthcareService.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
HealthcareService.category | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCategoryCodes | ||||
HealthcareService.type | required | http://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodeshttp://terminology.fhir.guide/co/ValueSet/REPShealthcareServiceCodes | ||||
HealthcareService.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
HealthcareService.telecom:TelecomPhone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomPhone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomMobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomMobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomEmail.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomEmail.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomURL.system | required | Fixed Value: urlhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom:TelecomURL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditionshttp://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard | ||||
HealthcareService.eligibility.code | example | |||||
HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/program from the FHIR Standard | ||||
HealthcareService.characteristic | example | |||||
HealthcareService.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard | ||||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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: 5 elements(13 nested mandatory elements)
Must-Support: 6 elements
Fixed: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron