Advance Care Planning (PZP)
1.0.0-rc1 - trial-use

This page is part of the Advance Care Planning (PZP) (v1.0.0-rc1: Release 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: ACPHealthProfessionalPractitionerRole - Detailed Descriptions

Draft as of 2025-10-30

Definitions for the ACP-HealthProfessional-PractitionerRole resource profile.

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

0. PractitionerRole
Definition

A health professional is a person who is authorized to perform actions in the field of individual healthcare.


A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

ShortHealthProfessionalRoles/organizations the practitioner is associated with
Comments

The zib HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to a profile on Practitioner (http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner) and this PractitionerRole profile. The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareProvider. The zib concepts Specialty and HealthcareProvider are therefore mapped onto PractitionerRole.

Although the zib concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part of the clinical resource for that specific case, for example in the Procedure.performer.role element. This prevents the creation of duplicate HealthProfessional instances for each clinical situation where the HealthProfessional performs a different role in the process.

Control0..*
Is Modifierfalse
Alternate NamesZorgverlener, nl-core-HealthProfessional-PractitionerRole
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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 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-6: A resource should have narrative for robust management (text.`div`.exists())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. PractitionerRole.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. PractitionerRole.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PractitionerRole.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. PractitionerRole.practitioner
    Definition

    Practitioner that is able to provide the defined services for the organization.

    ShortPractitioner that is able to provide the defined services for the organization
    Comments

    References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeReference(HealthProfessional Practitioner, Practitioner)
    Is Modifierfalse
    Obligations
      ObligationsActor
      SHALL:populate-if-knownACP Actor Provider
      SHALL:no-errorACP Actor Consulter
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. PractitionerRole.specialty
      Definition

      Specific specialty of the practitioner.

      ShortSpecific specialty of the practitioner
      Comments

      Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

      Control0..*
      This element is affected by the following invariants: ele-1
      BindingThe codes SHOULD be taken from PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1
      (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1)

      Specific specialty associated with the agency.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on PractitionerRole.specialty. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ $this
      • 10. PractitionerRole.specialty:specialty
        Slice Namespecialty
        Definition

        Health professional’s medical specialty. This refers to the recognized medical specialties as stated in the BIG Act. For example general practitioner or cardiologist.


        Specific specialty of the practitioner.

        ShortSpecialtySpecific specialty of the practitioner
        Comments

        The zib concept Specialty is mapped to a slice on the .specialty element instead of the element itself so that other terminology can be used next to the terminology required by the zib.

        Control0..1*
        This element is affected by the following invariants: ele-1
        BindingThe codes SHALL be taken from The codes SHOULD be taken from SpecialismeCodelijsten (2020-09-01T00:00:00)http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1
        (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.22--20200901000000|2020-09-01T00:00:00)

        Specific specialty associated with the agency.

        TypeCodeableConcept
        Is Modifierfalse
        Obligations
          ObligationsActor
          SHALL:populate-if-knownACP Actor Provider
          SHALL:no-errorACP Actor Consulter
          Summarytrue
          Alternate NamesSpecialisme
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. PractitionerRole.telecom
          Definition

          Health professional’s telephone number(s) or e-mail address(es) that are specific to the role/location/service.


          Contact details that are specific to the role/location/service.

          ShortContactInformationContact details that are specific to the role/location/service
          Comments

          The cardinality mismatch between the zib (0..1) and FHIR (0..*) is explained by the containers TelephoneNumbers (0..*) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers.

          Control0..*
          This element is affected by the following invariants: ele-1
          TypeContactPoint
          Is Modifierfalse
          Summarytrue
          Requirements

          Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

          Alternate NamesContactgegevens
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on PractitionerRole.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • profile @ $this
          • 14. PractitionerRole.telecom:telephoneNumbers
            Slice NametelephoneNumbers
            Definition

            Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


            Contact details that are specific to the role/location/service.

            ShortTelephoneNumbersContact details that are specific to the role/location/service
            Comments

            Implementation of the "TelephoneNumbers" concept of zib ContactInformation.

            Please note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts ContactPoint.system and ContactPoint.use respectively, a mismatch occurs on the concept of mobile phone numbers; the zib uses the first concept and FHIR the second. For this reason, the ValueSet on ContactPoint.system is too narrow and the zib code will need to be communicated using the ext-CodeSpecification extension.

            Control0..*
            This element is affected by the following invariants: ele-1
            TypeContactPoint(nl core ContactInformation TelephoneNumbers)
            Is Modifierfalse
            Summarytrue
            Requirements

            Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

            Alternate NamesTelefoonnummers, nl-core-ContactInformation-TelephoneNumbers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            16. PractitionerRole.telecom:emailAddresses
            Slice NameemailAddresses
            Definition

            Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


            Contact details that are specific to the role/location/service.

            ShortEmailAddressesContact details that are specific to the role/location/service
            Comments

            Implementation of the "EmailAddresses" concept of zib ContactInformation.

            Control0..*
            This element is affected by the following invariants: ele-1
            TypeContactPoint(nl core ContactInformation EmailAddresses)
            Is Modifierfalse
            Summarytrue
            Requirements

            Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

            Alternate NamesEmailAdressen, nl-core-ContactInformation-EmailAddresses
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

            0. PractitionerRole
            2. PractitionerRole.practitioner
            TypeReference(HealthProfessional Practitioner)
            Obligations
              ObligationsActor
              SHALL:populate-if-knownACP Actor Provider
              SHALL:no-errorACP Actor Consulter
              4. PractitionerRole.specialty:specialty
              Slice Namespecialty
              Obligations
                ObligationsActor
                SHALL:populate-if-knownACP Actor Provider
                SHALL:no-errorACP Actor Consulter

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

                0. PractitionerRole
                Definition

                A health professional is a person who is authorized to perform actions in the field of individual healthcare.

                ShortHealthProfessional
                Comments

                The zib HealthProfessional is mapped for all but one concept (HealthProfessionalRole) to a profile on Practitioner (http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner) and this PractitionerRole profile. The PractitionerRole resource covers the recording of the location and types of services that HealthProfessionals are able to provide for a HealthcareProvider. The zib concepts Specialty and HealthcareProvider are therefore mapped onto PractitionerRole.

                Although the zib concept name HealthProfessionalRole superficially seems to match the PractitionerRole resource, this is not the case based on the definition and values of that concept. In FHIR, the role that a HealthProfessional fulfills is captured as part of the clinical resource for that specific case, for example in the Procedure.performer.role element. This prevents the creation of duplicate HealthProfessional instances for each clinical situation where the HealthProfessional performs a different role in the process.

                Control0..*
                Alternate NamesZorgverlener, nl-core-HealthProfessional-PractitionerRole
                Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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 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-6: A resource should have narrative for robust management (text.`div`.exists())
                dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                2. PractitionerRole.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
                Summarytrue
                4. PractitionerRole.meta
                Definition

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

                ShortMetadata about the resource
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeMeta
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                6. PractitionerRole.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                Control0..1
                This element is affected by the following invariants: ele-1
                Typeuri
                Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                8. PractitionerRole.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
                This element is affected by the following invariants: ele-1
                BindingThe codes SHOULD be taken from CommonLanguages
                (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                A human language.

                Additional BindingsPurpose
                AllLanguagesMax Binding
                Typecode
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                10. PractitionerRole.text
                Definition

                A human-readable narrative that contains a summary of the resource and can 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 information is added later.

                Control0..1
                This element is affected by the following invariants: ele-1
                TypeNarrative
                Alternate Namesnarrative, html, xhtml, display
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                12. PractitionerRole.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

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

                May be used to represent additional information that is not part of the basic definition of the resource. 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 can 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..*
                This element is affected by the following invariants: ele-1
                TypeExtension
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on PractitionerRole.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 16. PractitionerRole.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  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..*
                  This element is affected by the following invariants: ele-1
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on PractitionerRole.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 18. PractitionerRole.identifier
                    Definition

                    Business Identifiers that are specific to a role/location.

                    ShortBusiness Identifiers that are specific to a role/location
                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..*
                    This element is affected by the following invariants: ele-1
                    TypeIdentifier
                    Summarytrue
                    Requirements

                    Often, specific identities are assigned for the agent.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    20. PractitionerRole.active
                    Definition

                    Whether this practitioner role record is in active use.

                    ShortWhether this practitioner role record is in active use
                    Comments

                    If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

                    Control0..1
                    This element is affected by the following invariants: ele-1
                    Typeboolean
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.

                    Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    22. PractitionerRole.period
                    Definition

                    The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

                    ShortThe period during which the practitioner is authorized to perform in these role(s)
                    Comments

                    A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                    Period is not used for a duration (a measure of elapsed time). See Duration.

                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypePeriod
                    Summarytrue
                    Requirements

                    Even after the agencies is revoked, the fact that it existed must still be recorded.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                    24. PractitionerRole.practitioner
                    Definition

                    Practitioner that is able to provide the defined services for the organization.

                    ShortPractitioner that is able to provide the defined services for the organization
                    Comments

                    References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeReference(HealthProfessional Practitioner)
                    Obligations
                      ObligationsActor
                      SHALL:populate-if-knownACP Actor Provider
                      SHALL:no-errorACP Actor Consulter
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
                      26. PractitionerRole.organization
                      Definition

                      The organization the health professional works for.

                      ShortHealthcareProvider
                      Comments

                      A HealthcareProvider in zib terms is primarily a location where care is provided, and so the zib concept HealthcareProvider (NL-CM:17.1.6) would normally be fulfilled using a reference to a Location resource (profile nl-core-HealthcareProvider). However, this particular context refers to the organizational aspects of a HealthcareProvider rather than its physical location:

                      • the zib concept name is not preceded by a role indicator of the zib (like Location::HealthcareProvider, concept id NL-CM:14.1.5, in the zib Procedure).
                      • the PractitionerRole.location cardinality (0..*) does not match the zib concept (0..1) and restricting it is not correct as a health professional could be working on multiple locations.

                      Therefore, this concept is fulfilled using a reference to the Organization resource (profile nl-core-HealthcareProvider-Organization) and mapped onto PractitionerRole.organization instead of PractitionerRole.location.

                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeReference(Organization, nl core HealthcareProvider Organization)
                      Summarytrue
                      Alternate NamesZorgaanbieder
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
                      28. PractitionerRole.code
                      Definition

                      Roles which this practitioner is authorized to perform for the organization.

                      ShortRoles which this practitioner may perform
                      Comments

                      A person may have more than one role.

                      Control0..*
                      This element is affected by the following invariants: ele-1
                      BindingFor example codes, see PractitionerRole
                      (example to http://hl7.org/fhir/ValueSet/practitioner-role|4.0.1)

                      The role a person plays representing an organization.

                      TypeCodeableConcept
                      Summarytrue
                      Requirements

                      Need to know what authority the practitioner has - what can they do?

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      30. PractitionerRole.specialty
                      Definition

                      Specific specialty of the practitioner.

                      ShortSpecific specialty of the practitioner
                      Comments

                      Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

                      Control0..*
                      This element is affected by the following invariants: ele-1
                      BindingThe codes SHOULD be taken from PracticeSettingCodeValueSet
                      (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1)

                      Specific specialty associated with the agency.

                      TypeCodeableConcept
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on PractitionerRole.specialty. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ $this
                      • 32. PractitionerRole.specialty:specialty
                        Slice Namespecialty
                        Definition

                        Health professional’s medical specialty. This refers to the recognized medical specialties as stated in the BIG Act. For example general practitioner or cardiologist.

                        ShortSpecialty
                        Comments

                        The zib concept Specialty is mapped to a slice on the .specialty element instead of the element itself so that other terminology can be used next to the terminology required by the zib.

                        Control0..1
                        This element is affected by the following invariants: ele-1
                        BindingThe codes SHALL be taken from SpecialismeCodelijsten (2020-09-01T00:00:00)
                        (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.22--20200901000000|2020-09-01T00:00:00)

                        Specific specialty associated with the agency.

                        TypeCodeableConcept
                        Obligations
                          ObligationsActor
                          SHALL:populate-if-knownACP Actor Provider
                          SHALL:no-errorACP Actor Consulter
                          Summarytrue
                          Alternate NamesSpecialisme
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          34. PractitionerRole.location
                          Definition

                          The location(s) at which this practitioner provides care.

                          ShortThe location(s) at which this practitioner provides care
                          Comments

                          References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

                          Control0..*
                          This element is affected by the following invariants: ele-1
                          TypeReference(Location, nl core HealthcareProvider)
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
                          36. PractitionerRole.healthcareService
                          Definition

                          The list of healthcare services that this worker provides for this role's Organization/Location(s).

                          ShortThe list of healthcare services that this worker provides for this role's Organization/Location(s)
                          Comments

                          References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

                          Control0..*
                          This element is affected by the following invariants: ele-1
                          TypeReference(HealthcareService)
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
                          38. PractitionerRole.telecom
                          Definition

                          Health professional’s telephone number(s) or e-mail address(es) that are specific to the role/location/service.

                          ShortContactInformation
                          Comments

                          The cardinality mismatch between the zib (0..1) and FHIR (0..*) is explained by the containers TelephoneNumbers (0..*) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers.

                          Control0..*
                          This element is affected by the following invariants: ele-1
                          TypeContactPoint
                          Summarytrue
                          Requirements

                          Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

                          Alternate NamesContactgegevens
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                          SlicingThis element introduces a set of slices on PractitionerRole.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • profile @ $this
                          • 40. PractitionerRole.telecom:telephoneNumbers
                            Slice NametelephoneNumbers
                            Definition

                            Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                            ShortTelephoneNumbers
                            Comments

                            Implementation of the "TelephoneNumbers" concept of zib ContactInformation.

                            Please note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts ContactPoint.system and ContactPoint.use respectively, a mismatch occurs on the concept of mobile phone numbers; the zib uses the first concept and FHIR the second. For this reason, the ValueSet on ContactPoint.system is too narrow and the zib code will need to be communicated using the ext-CodeSpecification extension.

                            Control0..*
                            This element is affected by the following invariants: ele-1
                            TypeContactPoint(nl core ContactInformation TelephoneNumbers)
                            Summarytrue
                            Requirements

                            Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

                            Alternate NamesTelefoonnummers, nl-core-ContactInformation-TelephoneNumbers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                            42. PractitionerRole.telecom:emailAddresses
                            Slice NameemailAddresses
                            Definition

                            Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                            ShortEmailAddresses
                            Comments

                            Implementation of the "EmailAddresses" concept of zib ContactInformation.

                            Control0..*
                            This element is affected by the following invariants: ele-1
                            TypeContactPoint(nl core ContactInformation EmailAddresses)
                            Summarytrue
                            Requirements

                            Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

                            Alternate NamesEmailAdressen, nl-core-ContactInformation-EmailAddresses
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                            44. PractitionerRole.availableTime
                            Definition

                            A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

                            ShortTimes the Service Site is available
                            Comments

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

                            Control0..*
                            This element is affected by the following invariants: ele-1
                            TypeBackboneElement
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            46. PractitionerRole.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.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            XML FormatIn the XML format, this property is represented as an attribute.
                            48. PractitionerRole.availableTime.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. 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 can 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..*
                            This element is affected by the following invariants: ele-1
                            TypeExtension
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on PractitionerRole.availableTime.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 50. PractitionerRole.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                              ShortExtensions that cannot be ignored even if unrecognized
                              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..*
                              This element is affected by the following invariants: ele-1
                              TypeExtension
                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                              Summarytrue
                              Requirements

                              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                              Alternate Namesextensions, user content, modifiers
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              52. PractitionerRole.availableTime.daysOfWeek
                              Definition

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

                              Shortmon | tue | wed | thu | fri | sat | sun
                              Comments

                              Note that FHIR strings SHALL NOT exceed 1MB in size

                              Control0..*
                              This element is affected by the following invariants: ele-1
                              BindingThe codes SHALL be taken from DaysOfWeek
                              (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1)

                              The days of the week.

                              Typecode
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              54. PractitionerRole.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
                              This element is affected by the following invariants: ele-1
                              Typeboolean
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              56. PractitionerRole.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
                              This element is affected by the following invariants: ele-1
                              Typetime
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              58. PractitionerRole.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
                              This element is affected by the following invariants: ele-1
                              Typetime
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              60. PractitionerRole.notAvailable
                              Definition

                              The practitioner is not available or performing this role during this period of time due to the provided reason.

                              ShortNot available during this time due to provided reason
                              Control0..*
                              This element is affected by the following invariants: ele-1
                              TypeBackboneElement
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              62. PractitionerRole.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.

                              ShortUnique id for inter-element referencing
                              Control0..1
                              Typestring
                              XML FormatIn the XML format, this property is represented as an attribute.
                              64. PractitionerRole.notAvailable.extension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element. 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 can 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..*
                              This element is affected by the following invariants: ele-1
                              TypeExtension
                              Alternate Namesextensions, user content
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              SlicingThis element introduces a set of slices on PractitionerRole.notAvailable.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 66. PractitionerRole.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                ShortExtensions that cannot be ignored even if unrecognized
                                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..*
                                This element is affected by the following invariants: ele-1
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                68. PractitionerRole.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
                                Comments

                                Note that FHIR strings SHALL NOT exceed 1MB in size

                                Control1..1
                                This element is affected by the following invariants: ele-1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                70. PractitionerRole.notAvailable.during
                                Definition

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

                                ShortService not available from this date
                                Comments

                                A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                                Period is not used for a duration (a measure of elapsed time). See Duration.

                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypePeriod
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                                72. PractitionerRole.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
                                Comments

                                Note that FHIR strings SHALL NOT exceed 1MB in size

                                Control0..1
                                This element is affected by the following invariants: ele-1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                74. PractitionerRole.endpoint
                                Definition

                                Technical endpoints providing access to services operated for the practitioner with this role.

                                ShortTechnical endpoints providing access to services operated for the practitioner with this role
                                Comments

                                References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

                                Control0..*
                                This element is affected by the following invariants: ele-1
                                TypeReference(Endpoint)
                                Requirements

                                Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.

                                So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))