Netherlands - Generic Functions for data exchange Implementation Guide
0.3.0 - ci-build Netherlands flag

Netherlands - Generic Functions for data exchange Implementation Guide, published by Stichting Nuts. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nuts-foundation/nl-generic-functions-ig/ and changes regularly. See the Directory of published versions

Resource Profile: NL Generic Functions HealthcareService Profile

Official URL: http://nuts-foundation.github.io/nl-generic-functions-ig/StructureDefinition/nl-gf-healthcareservice Version: 0.3.0
Draft as of 2025-12-04 Computable Name: NlGfHealthcareService

The technical details of a healthcare service that can be used in referrals, requests and orders

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... Slices for identifier Σ 1..* Identifier External identifiers for this item
Slice: Unordered, Open by value:$this
.... identifier:AssignedId Σ 1..1 Identifier External identifiers for this item
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... assigner Σ 1..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 1..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.
........ coding Σ 1..1 Coding Code defined by a terminology system
......... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
......... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: author
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
....... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
... providedBy Σ 1..1 Reference(Organization) Organization that provides this service
.... Slices for extension Content/Rules for all slices
..... extension:supportedActivityDefinitions 0..* canonical(ActivityDefinition | PlanDefinition) Supported ActivityDefinitions and PlanDefinitions by HealthcareServices
URL: http://nuts-foundation.github.io/nl-generic-functions-ig/StructureDefinition/supported-activity-definitions
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: SpecialismeCodelijsten (required)
... name Σ 1..1 string Description of service as presented to a consumer while searching

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.identifier:AssignedId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
HealthcareService.type Base required VerrichtingTypeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
HealthcareService.specialty Base required SpecialismeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... implicitRules 0..0 A set of rules under which this content was created
... modifierExtension 0..0 Extension
... Slices for identifier 1..* Identifier External identifiers for this item
Slice: Unordered, Open by value:$this
.... identifier:AssignedId 1..1 Identifier External identifiers for this item
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
..... assigner 1..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... type 1..1 CodeableConcept Description of identifier
........ coding 1..1 Coding Code defined by a terminology system
......... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
......... code 0..1 code Symbol in syntax defined by the system
Required Pattern: author
....... system 0..1 uri The namespace for the identifier value
Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
....... value 1..1 string The value that is unique
... type 1..* CodeableConcept Type of service that may be delivered or performed
Binding: VerrichtingTypeCodelijsten (required)
.... Slices for extension Content/Rules for all slices
..... extension:supportedActivityDefinitions 0..* canonical(ActivityDefinition | PlanDefinition) Supported ActivityDefinitions and PlanDefinitions by HealthcareServices
URL: http://nuts-foundation.github.io/nl-generic-functions-ig/StructureDefinition/supported-activity-definitions
... specialty 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: SpecialismeCodelijsten (required)
... name 1..1 string Description of service as presented to a consumer while searching

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HealthcareService.type Base required VerrichtingTypeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
HealthcareService.specialty Base required SpecialismeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... Slices for identifier Σ 1..* Identifier External identifiers for this item
Slice: Unordered, Open by value:$this
.... identifier:AssignedId Σ 1..1 Identifier External identifiers for this item
..... 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 .
..... 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 Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 1..1 Reference(Organization) Organization that issued id (may be just text)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... 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 .
....... type Σ 1..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.
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 1..1 Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
......... version Σ 0..1 string Version of the system - if relevant
......... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: author
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
....... value Σ 1..1 string The value that is unique
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)
...... display Σ 0..1 string Text alternative for the resource
... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
... providedBy Σ 1..1 Reference(Organization) Organization that provides this service
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
... type Σ 1..* CodeableConcept Type of service that may be delivered or performed
Binding: VerrichtingTypeCodelijsten (required)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:supportedActivityDefinitions 0..* canonical(ActivityDefinition | PlanDefinition) Supported ActivityDefinitions and PlanDefinitions by HealthcareServices
URL: http://nuts-foundation.github.io/nl-generic-functions-ig/StructureDefinition/supported-activity-definitions
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: SpecialismeCodelijsten (required)
... location Σ 0..* Reference(Location) Location(s) where service may be provided
... name Σ 1..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
... telecom 0..* ContactPoint Contacts related to the healthcare service
... 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: (example): Coded values underwhich a specific service is made available.
.... comment 0..1 markdown Describes the eligibility conditions for the service
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding Description: (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.
Additional BindingsPurpose
AllLanguages Max Binding

... 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): The days of the week.
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
HealthcareService.category Base example Service category 📍4.0.1 FHIR Std.
HealthcareService.type Base required VerrichtingTypeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
HealthcareService.specialty Base required SpecialismeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
HealthcareService.serviceProvisionCode Base example ServiceProvisionConditions 📍4.0.1 FHIR Std.
HealthcareService.eligibility.​code Base example Not State Unknown
HealthcareService.program Base example Program 📍4.0.1 FHIR Std.
HealthcareService.characteristic Base example Not State Unknown
HealthcareService.communication Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.referralMethod Base example ReferralMethod 📍4.0.1 FHIR Std.
HealthcareService.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from HealthcareService

Summary

Mandatory: 12 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of HealthcareService.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... Slices for identifier Σ 1..* Identifier External identifiers for this item
Slice: Unordered, Open by value:$this
.... identifier:AssignedId Σ 1..1 Identifier External identifiers for this item
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... assigner Σ 1..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 1..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.
........ coding Σ 1..1 Coding Code defined by a terminology system
......... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
......... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: author
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
....... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
... providedBy Σ 1..1 Reference(Organization) Organization that provides this service
.... Slices for extension Content/Rules for all slices
..... extension:supportedActivityDefinitions 0..* canonical(ActivityDefinition | PlanDefinition) Supported ActivityDefinitions and PlanDefinitions by HealthcareServices
URL: http://nuts-foundation.github.io/nl-generic-functions-ig/StructureDefinition/supported-activity-definitions
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: SpecialismeCodelijsten (required)
... name Σ 1..1 string Description of service as presented to a consumer while searching

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.identifier:AssignedId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
HealthcareService.type Base required VerrichtingTypeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
HealthcareService.specialty Base required SpecialismeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... implicitRules 0..0 A set of rules under which this content was created
... modifierExtension 0..0 Extension
... Slices for identifier 1..* Identifier External identifiers for this item
Slice: Unordered, Open by value:$this
.... identifier:AssignedId 1..1 Identifier External identifiers for this item
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
..... assigner 1..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... type 1..1 CodeableConcept Description of identifier
........ coding 1..1 Coding Code defined by a terminology system
......... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
......... code 0..1 code Symbol in syntax defined by the system
Required Pattern: author
....... system 0..1 uri The namespace for the identifier value
Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
....... value 1..1 string The value that is unique
... type 1..* CodeableConcept Type of service that may be delivered or performed
Binding: VerrichtingTypeCodelijsten (required)
.... Slices for extension Content/Rules for all slices
..... extension:supportedActivityDefinitions 0..* canonical(ActivityDefinition | PlanDefinition) Supported ActivityDefinitions and PlanDefinitions by HealthcareServices
URL: http://nuts-foundation.github.io/nl-generic-functions-ig/StructureDefinition/supported-activity-definitions
... specialty 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: SpecialismeCodelijsten (required)
... name 1..1 string Description of service as presented to a consumer while searching

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HealthcareService.type Base required VerrichtingTypeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
HealthcareService.specialty Base required SpecialismeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... Slices for identifier Σ 1..* Identifier External identifiers for this item
Slice: Unordered, Open by value:$this
.... identifier:AssignedId Σ 1..1 Identifier External identifiers for this item
..... 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 .
..... 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 Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 1..1 Reference(Organization) Organization that issued id (may be just text)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... 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 .
....... type Σ 1..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.
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 1..1 Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
......... version Σ 0..1 string Version of the system - if relevant
......... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: author
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
....... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
....... value Σ 1..1 string The value that is unique
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)
...... display Σ 0..1 string Text alternative for the resource
... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
... providedBy Σ 1..1 Reference(Organization) Organization that provides this service
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
... type Σ 1..* CodeableConcept Type of service that may be delivered or performed
Binding: VerrichtingTypeCodelijsten (required)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:supportedActivityDefinitions 0..* canonical(ActivityDefinition | PlanDefinition) Supported ActivityDefinitions and PlanDefinitions by HealthcareServices
URL: http://nuts-foundation.github.io/nl-generic-functions-ig/StructureDefinition/supported-activity-definitions
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: SpecialismeCodelijsten (required)
... location Σ 0..* Reference(Location) Location(s) where service may be provided
... name Σ 1..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
... telecom 0..* ContactPoint Contacts related to the healthcare service
... 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: (example): Coded values underwhich a specific service is made available.
.... comment 0..1 markdown Describes the eligibility conditions for the service
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding Description: (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.
Additional BindingsPurpose
AllLanguages Max Binding

... 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): The days of the week.
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
HealthcareService.identifier:AssignedId.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
HealthcareService.category Base example Service category 📍4.0.1 FHIR Std.
HealthcareService.type Base required VerrichtingTypeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
HealthcareService.specialty Base required SpecialismeCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
HealthcareService.serviceProvisionCode Base example ServiceProvisionConditions 📍4.0.1 FHIR Std.
HealthcareService.eligibility.​code Base example Not State Unknown
HealthcareService.program Base example Program 📍4.0.1 FHIR Std.
HealthcareService.characteristic Base example Not State Unknown
HealthcareService.communication Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.referralMethod Base example ReferralMethod 📍4.0.1 FHIR Std.
HealthcareService.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from HealthcareService

Summary

Mandatory: 12 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of HealthcareService.identifier

 

Other representations of profile: CSV, Excel, Schematron