Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: nl-core-healthcareservice - Detailed Descriptions

Active as of 2024-04-09

Definitions for the nl-core-healthcareservice resource profile.

Guidance on how to interpret the contents of this table can be found here

0. HealthcareService
2. HealthcareService.providedBy
TypeReference(nl-core-organization)
4. HealthcareService.location
TypeReference(nl-core-location)
6. HealthcareService.telecom
ShortContactInformation
TypeContactPoint(nl-core-contactpoint)
Alternate NamesContactgegevens
8. HealthcareService.coverageArea
TypeReference(nl-core-location)

Guidance on how to interpret the contents of this table can be found here

0. HealthcareService
Definition

The details of a healthcare service available at a location.

ShortThe details of a healthcare service available at a location
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. HealthcareService.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. HealthcareService.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
6. HealthcareService.active
Definition

Whether this healthcareservice record is in active use.

ShortWhether this healthcareservice is in active use
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Control0..1
Typeboolean
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Default Valuetrue
8. HealthcareService.providedBy
Definition

The organization that provides this healthcare service.

ShortOrganization that provides this service
Comments

This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.

Control0..1
TypeReference(nl-core-organization, Organization)
Summarytrue
10. HealthcareService.location
Definition

The location(s) where this healthcare service may be provided.

ShortLocation(s) where service may be provided
Control0..*
TypeReference(nl-core-location, Location)
Summarytrue
12. HealthcareService.telecom
Definition

Contact information includes a person's telephone numbers en e-mail addresses.


List of contacts related to this specific healthcare service.

ShortContactInformationContacts related to the healthcare service
Comments

If this is empty, then refer to the location's contacts.

Control0..*
This element is affected by the following invariants: ele-1
TypeContactPoint(nl-core-contactpoint)
Alternate NamesContactgegevens
Example<br/><b>Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "work" } <br/><b>Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "mobile" } <br/><b>Primary Home Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Private email address</b>:{ "system" : "email", "value" : "giesput@myweb.nl", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
14. HealthcareService.coverageArea
Definition

The location(s) that this service is available to (not where the service is provided).

ShortLocation(s) service is inteded for/available to
Comments

The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".

Control0..*
TypeReference(nl-core-location, Location)

Guidance on how to interpret the contents of this table can be found here

0. HealthcareService
Definition

The details of a healthcare service available at a location.

ShortThe details of a healthcare service available at a location
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. HealthcareService.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. HealthcareService.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Summarytrue
6. HealthcareService.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
8. HealthcareService.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Common Languages
(extensible to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HealthcareService.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

Control0..1
This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
12. HealthcareService.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
14. HealthcareService.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional Content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Alternate Namesextensions, user content
16. HealthcareService.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
18. HealthcareService.identifier
Definition

External identifiers for this item.

ShortExternal identifiers for this item
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
20. HealthcareService.active
Definition

Whether this healthcareservice record is in active use.

ShortWhether this healthcareservice is in active use
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Control0..1
Typeboolean
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Default Valuetrue
22. HealthcareService.providedBy
Definition

The organization that provides this healthcare service.

ShortOrganization that provides this service
Comments

This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.

Control0..1
TypeReference(nl-core-organization)
Summarytrue
24. HealthcareService.category
Definition

Identifies the broad category of service being performed or delivered.

ShortBroad category of service being performed or delivered
Comments

Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.

Control0..1
BindingFor example codes, see ServiceCategory
(example to http://hl7.org/fhir/ValueSet/service-category)

A category of the service(s) that could be provided.

TypeCodeableConcept
Summarytrue
Alternate Namesservice category
26. HealthcareService.type
Definition

The specific type of service that may be delivered or performed.

ShortType of service that may be delivered or performed
Control0..*
BindingFor example codes, see ServiceType
(example to http://hl7.org/fhir/ValueSet/service-type)

Additional details about where the content was created (e.g. clinical specialty).

TypeCodeableConcept
Summarytrue
Alternate Namesservice type
28. HealthcareService.specialty
Definition

Collection of specialties handled by the service site. This is more of a medical term.

ShortSpecialties handled by the HealthcareService
Control0..*
BindingThe codes SHOULD be taken from Practice Setting Code Value Set
(preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes)

A specialty that a healthcare service may provide.

TypeCodeableConcept
Summarytrue
30. HealthcareService.location
Definition

The location(s) where this healthcare service may be provided.

ShortLocation(s) where service may be provided
Control0..*
TypeReference(nl-core-location)
Summarytrue
32. HealthcareService.name
Definition

Further description of the service as it would be presented to a consumer while searching.

ShortDescription of service as presented to a consumer while searching
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
34. HealthcareService.comment
Definition

Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

ShortAdditional description and/or any specific issues not covered elsewhere
Comments

Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
36. HealthcareService.extraDetails
Definition

Extra details about the service that can't be placed in the other fields.

ShortExtra details about the service that can't be placed in the other fields
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. HealthcareService.photo
Definition

If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

ShortFacilitates quick identification of the service
Control0..1
TypeAttachment
Summarytrue
40. HealthcareService.telecom
Definition

Contact information includes a person's telephone numbers en e-mail addresses.

ShortContactInformation
Comments

If this is empty, then refer to the location's contacts.

Control0..*
This element is affected by the following invariants: ele-1
TypeContactPoint(nl-core-contactpoint)
Alternate NamesContactgegevens
Example<br/><b>Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "work" } <br/><b>Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "mobile" } <br/><b>Primary Home Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Private email address</b>:{ "system" : "email", "value" : "giesput@myweb.nl", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
42. HealthcareService.coverageArea
Definition

The location(s) that this service is available to (not where the service is provided).

ShortLocation(s) service is inteded for/available to
Comments

The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".

Control0..*
TypeReference(nl-core-location)
44. HealthcareService.serviceProvisionCode
Definition

The code(s) that detail the conditions under which the healthcare service is available/offered.

ShortConditions under which service is available/offered
Comments

The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.

Control0..*
BindingFor example codes, see ServiceProvisionConditions
(example to http://hl7.org/fhir/ValueSet/service-provision-conditions)

The code(s) that detail the conditions under which the healthcare service is available/offered.

TypeCodeableConcept
46. HealthcareService.eligibility
Definition

Does this service have specific eligibility requirements that need to be met in order to use the service?

ShortSpecific eligibility requirements required to use the service
Control0..1
Binding

Coded values underwhich a specific service is made available.

TypeCodeableConcept
48. HealthcareService.eligibilityNote
Definition

Describes the eligibility conditions for the service.

ShortDescribes the eligibility conditions for the service
Comments

The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
50. HealthcareService.programName
Definition

Program Names that can be used to categorize the service.

ShortProgram Names that categorize the service
Comments

Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….

Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. HealthcareService.characteristic
Definition

Collection of characteristics (attributes).

ShortCollection of characteristics (attributes)
Comments

These could be such things as is wheelchair accessible.

Control0..*
Binding

A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).

TypeCodeableConcept
54. HealthcareService.referralMethod
Definition

Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

ShortWays that the service accepts referrals
Control0..*
BindingFor example codes, see ReferralMethod
(example to http://hl7.org/fhir/ValueSet/service-referral-method)

The methods of referral can be used when referring to a specific HealthCareService resource.

TypeCodeableConcept
56. HealthcareService.appointmentRequired
Definition

Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

ShortIf an appointment is required for access to this service
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
58. HealthcareService.availableTime
Definition

A collection of times that the Service Site is available.

ShortTimes the Service Site is available
Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
60. HealthcareService.availableTime.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
62. HealthcareService.availableTime.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional Content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Alternate Namesextensions, user content
64. HealthcareService.availableTime.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Summarytrue
Alternate Namesextensions, user content, modifiers
66. HealthcareService.availableTime.daysOfWeek
Definition

Indicates which days of the week are available between the start and end Times.

Shortmon | tue | wed | thu | fri | sat | sun
Control0..*
BindingThe codes SHALL be taken from DaysOfWeek
(required to http://hl7.org/fhir/ValueSet/days-of-week)

The days of the week.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
68. HealthcareService.availableTime.allDay
Definition

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

ShortAlways available? e.g. 24 hour service
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. HealthcareService.availableTime.availableStartTime
Definition

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

ShortOpening time of day (ignored if allDay = true)
Comments

The timezone is expected to be for where this HealthcareService is provided at.

Control0..1
Typetime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
72. HealthcareService.availableTime.availableEndTime
Definition

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

ShortClosing time of day (ignored if allDay = true)
Comments

The timezone is expected to be for where this HealthcareService is provided at.

Control0..1
Typetime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
74. HealthcareService.notAvailable
Definition

The HealthcareService is not available during this period of time due to the provided reason.

ShortNot available during this time due to provided reason
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
76. HealthcareService.notAvailable.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
78. HealthcareService.notAvailable.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional Content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Alternate Namesextensions, user content
80. HealthcareService.notAvailable.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Summarytrue
Alternate Namesextensions, user content, modifiers
82. HealthcareService.notAvailable.description
Definition

The reason that can be presented to the user as to why this time is not available.

ShortReason presented to the user explaining why time not available
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
84. HealthcareService.notAvailable.during
Definition

Service is not available (seasonally or for a public holiday) from this date.

ShortService not availablefrom this date
Control0..1
TypePeriod
86. HealthcareService.availabilityExceptions
Definition

A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

ShortDescription of availability exceptions
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
88. HealthcareService.endpoint
Definition

Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

ShortTechnical endpoints providing access to services operated for the location
Control0..*
TypeReference(Endpoint)
Requirements

Organizations may have different systems covering different services at the different locations and need to be able to define the technical connection details for how to connect to them, and for what purpose.