RIVO Noord Zorgviewer MVP2 Implementation Guide
0.2.1 - CI build
RIVO Noord Zorgviewer MVP2 Implementation Guide - Local Development build (v0.2.1). See the Directory of published versions
Draft as of 2023-03-22 |
Definitions for the PractitionerRole resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. PractitionerRole | |
2. PractitionerRole.specialty | |
Control | 0..? |
3. PractitionerRole.specialty.coding:SpecialtyAGB | |
SliceName | SpecialtyAGB |
Must Support | true |
Invariants | Defined on this element zv-prr-1: PractitionerRole Specialty COD016 Vektiz AGB medische specialismen code SHOULD be present. (: (identifier.exists())) |
Guidance on how to interpret the contents of this table can be found here.
1. PractitionerRole | |
Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. |
Control | 0..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.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 (: contained.where(('#'+id in %resource.descendants().reference).not()).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()) |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Summary | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
3. 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
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. |
4. PractitionerRole.specialty | |
Definition | Health professional’s medical specialty. This refers to the recognized medical specialties as stated in the BIG Act. A PractitionerRole instance SHALL be a singular association between a person acting in a certain specialty for a certain organization. It's possible however that either specialty or organization or both is/are unknown. It is also possible that equivalent specialisms are available in multiple coding systems e.g. 01.015 UZI (Huisarts) and 0101 AGB (Huisartsen, niet apotheekhoudend). For this reason you may use multiple coding elements, each indicating the relevant code from a different system. Specific specialty of the practitioner. |
Control | 0..1* |
Binding | The codes SHOULD be taken from Practice Setting Code Value Set Specific specialty associated with the agency |
Type | CodeableConcept |
Summary | true |
Alternate Names | Specialisme |
5. PractitionerRole.specialty.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Slicing | This element introduces a set of slices on PractitionerRole.specialty.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
6. PractitionerRole.specialty.coding:SpecialtyUZI | |
SliceName | SpecialtyUZI |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Binding | The codes SHALL be taken from SpecialismeUZICodelijstFor codes, see (unbound) |
Type | Coding |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Alternate Names | SpecialismeUZI |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
7. PractitionerRole.specialty.coding:SpecialtyUZI.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://fhir.nl/fhir/NamingSystem/uzi-rolcode |
8. PractitionerRole.specialty.coding:SpecialtyAGB | |
SliceName | SpecialtyAGB |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Binding | The codes SHALL be taken from SpecialismeAGBCodelijstFor codes, see (unbound) |
Type | Coding |
Must Support | true |
Summary | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Alternate Names | SpecialismeAGB |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants | Defined on this element zv-prr-1: PractitionerRole Specialty COD016 Vektiz AGB medische specialismen code SHOULD be present. (: (identifier.exists())) |
9. PractitionerRole.specialty.coding:SpecialtyAGB.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | urn:oid:2.16.840.1.113883.2.4.6.7 |
Guidance on how to interpret the contents of this table can be found here.
1. PractitionerRole | |||||
Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. | ||||
Control | 0..* | ||||
2. PractitionerRole.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Summary | true | ||||
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. | ||||
3. PractitionerRole.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
4. 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | true | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
5. PractitionerRole.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
A human language
| ||||
Type | code | ||||
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). | ||||
6. PractitionerRole.text | |||||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
7. 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained 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. | ||||
8. PractitionerRole.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
9. 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
10. PractitionerRole.identifier | |||||
Definition | Business Identifiers that are specific to a role/location. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Often, specific identities are assigned for the agent. | ||||
11. PractitionerRole.active | |||||
Definition | Whether this practitioner's record is in active use. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. | ||||
Comments | Default is true. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. | ||||
Default Value | true | ||||
12. PractitionerRole.period | |||||
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. | ||||
13. PractitionerRole.practitioner | |||||
Definition | Practitioner that is able to provide the defined services for the organation. | ||||
Control | 0..1 | ||||
Type | Reference(nl-core-practitioner) | ||||
Summary | true | ||||
14. PractitionerRole.organization | |||||
Definition | The organization where the Practitioner performs the roles associated. | ||||
Control | 0..1 | ||||
Type | Reference(nl-core-organization) | ||||
Summary | true | ||||
Alternate Names | Zorgaanbieder | ||||
15. PractitionerRole.code | |||||
Definition | Roles which this practitioner is authorized to perform for the organization. | ||||
Control | 0..* | ||||
Binding | For example codes, see PractitionerRole The role a person plays representing an organizatio | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Need to know what authority the practitioner has - what can they do? | ||||
Comments | A person may have more than one role. Note: in earlier versions of this profile there used to be an association with the HCIM element NL-CM:17.1.5 HealthProfessionalRole. This mapping was semantically incorrect. The HCIM element is a property of the association of PractitionerRole to some healthcare act. In a number of FHIR Resources the association is implicit from the semantics of the resource element like in | ||||
16. PractitionerRole.specialty | |||||
Definition | Health professional’s medical specialty. This refers to the recognized medical specialties as stated in the BIG Act. A PractitionerRole instance SHALL be a singular association between a person acting in a certain specialty for a certain organization. It's possible however that either specialty or organization or both is/are unknown. It is also possible that equivalent specialisms are available in multiple coding systems e.g. 01.015 UZI (Huisarts) and 0101 AGB (Huisartsen, niet apotheekhoudend). For this reason you may use multiple coding elements, each indicating the relevant code from a different system. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from Practice Setting Code Value Set Specific specialty associated with the agenc | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Alternate Names | Specialisme | ||||
17. PractitionerRole.specialty.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
18. PractitionerRole.specialty.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Slicing | This element introduces a set of slices on PractitionerRole.specialty.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
19. PractitionerRole.specialty.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Slicing | This element introduces a set of slices on PractitionerRole.specialty.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
20. PractitionerRole.specialty.coding:SpecialtyUZI | |||||
SliceName | SpecialtyUZI | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from SpecialismeUZICodelijst | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Alternate Names | SpecialismeUZI | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
21. PractitionerRole.specialty.coding:SpecialtyUZI.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
22. PractitionerRole.specialty.coding:SpecialtyUZI.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Slicing | This element introduces a set of slices on PractitionerRole.specialty.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
23. PractitionerRole.specialty.coding:SpecialtyUZI.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Fixed Value | http://fhir.nl/fhir/NamingSystem/uzi-rolcode | ||||
24. PractitionerRole.specialty.coding:SpecialtyUZI.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
25. PractitionerRole.specialty.coding:SpecialtyUZI.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
26. PractitionerRole.specialty.coding:SpecialtyUZI.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
27. PractitionerRole.specialty.coding:SpecialtyUZI.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
28. PractitionerRole.specialty.coding:SpecialtyAGB | |||||
SliceName | SpecialtyAGB | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from SpecialismeAGBCodelijst | ||||
Type | Coding | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Alternate Names | SpecialismeAGB | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Invariants | Defined on this element zv-prr-1: PractitionerRole Specialty COD016 Vektiz AGB medische specialismen code SHOULD be present. (: (identifier.exists())) | ||||
29. PractitionerRole.specialty.coding:SpecialtyAGB.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
30. PractitionerRole.specialty.coding:SpecialtyAGB.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
Slicing | This element introduces a set of slices on PractitionerRole.specialty.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
31. PractitionerRole.specialty.coding:SpecialtyAGB.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Fixed Value | urn:oid:2.16.840.1.113883.2.4.6.7 | ||||
32. PractitionerRole.specialty.coding:SpecialtyAGB.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
33. PractitionerRole.specialty.coding:SpecialtyAGB.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
34. PractitionerRole.specialty.coding:SpecialtyAGB.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
35. PractitionerRole.specialty.coding:SpecialtyAGB.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
36. PractitionerRole.specialty.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
37. PractitionerRole.location | |||||
Definition | The location(s) at which this practitioner provides care. | ||||
Control | 0..* | ||||
Type | Reference(Location) | ||||
Summary | true | ||||
38. PractitionerRole.healthcareService | |||||
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s). | ||||
Control | 0..* | ||||
Type | Reference(HealthcareService) | ||||
39. PractitionerRole.telecom | |||||
Definition | Contact information includes a person's telephone numbers and email addresses. This datatype defines a common basis for expressing all contact information around the world, but adds extensions to express Dutch contacts specifically, according to the HCIM ContactInformation (v1.0, 2017). A Dutch ContactPoint still is a proper FHIR ContactPoint, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. The table below explains how the HCIM concepts are mapped to the various FHIR elements. The HCIM code itself should also be included using the TelecomType extension. | HCIM | | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | ContactPoint(nl-core-contactpoint) | ||||
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 Names | Contactgegevens | ||||
Example | Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.:<valueContactPoint xmlns="http://hl7.org/fhir"> <system value="phone"/> <value value="+31611234567"/> <use value="work"/> </valueContactPoint> Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.:<valueContactPoint xmlns="http://hl7.org/fhir"> <system value="phone"/> <value value="+31611234567"/> <use value="mobile"/> </valueContactPoint> Primary Home Land Line:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/> <code value="LL"/> <display value="Land Line"/> </coding> </valueCodeableConcept> </extension> <system value="phone"/> <value value="..."/> <use value="home"/> </valueContactPoint> Temporary Land Line:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/> <code value="LL"/> <display value="Land Line"/> </coding> </valueCodeableConcept> </extension> <system value="phone"/> <value value="..."/> <use value="temp"/> </valueContactPoint> Primary Work Land Line:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/> <code value="LL"/> <display value="Land Line"/> </coding> </valueCodeableConcept> </extension> <system value="phone"/> <value value="..."/> <use value="work"/> </valueContactPoint> Primary Home Fax:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/> <code value="FAX"/> <display value="Fax"/> </coding> </valueCodeableConcept> </extension> <system value="fax"/> <value value="..."/> <use value="home"/> </valueContactPoint> Temporary Fax:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/> <code value="FAX"/> <display value="Fax"/> </coding> </valueCodeableConcept> </extension> <system value="fax"/> <value value="..."/> <use value="temp"/> </valueContactPoint> Primary Work Fax:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/> <code value="FAX"/> <display value="Fax"/> </coding> </valueCodeableConcept> </extension> <system value="fax"/> <value value="..."/> <use value="work"/> </valueContactPoint> Primary Home Mobile Phone:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/v3/AddressUse"/> <code value="MC"/> <display value="Mobile Phone"/> </coding> </valueCodeableConcept> </extension> <system value="phone"/> <value value="..."/> <use value="home"/> </valueContactPoint> Temporary Mobile Phone:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/v3/AddressUse"/> <code value="MC"/> <display value="Mobile Phone"/> </coding> </valueCodeableConcept> </extension> <system value="phone"/> <value value="..."/> <use value="temp"/> </valueContactPoint> Primary Work Mobile Phone:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/v3/AddressUse"/> <code value="MC"/> <display value="Mobile Phone"/> </coding> </valueCodeableConcept> </extension> <system value="phone"/> <value value="..."/> <use value="work"/> </valueContactPoint> Primary Home Pager:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/v3/AddressUse"/> <code value="PG"/> <display value="Pager"/> </coding> </valueCodeableConcept> </extension> <system value="pager"/> <value value="..."/> <use value="home"/> </valueContactPoint> Temporary Pager:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/v3/AddressUse"/> <code value="PG"/> <display value="Pager"/> </coding> </valueCodeableConcept> </extension> <system value="pager"/> <value value="..."/> <use value="temp"/> </valueContactPoint> Primary Work Pager:<valueContactPoint xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/v3/AddressUse"/> <code value="PG"/> <display value="Pager"/> </coding> </valueCodeableConcept> </extension> <system value="pager"/> <value value="..."/> <use value="work"/> </valueContactPoint> Private email address:<valueContactPoint xmlns="http://hl7.org/fhir"> <system value="email"/> <value value="giesput@myweb.nl"/> <use value="home"/> </valueContactPoint> Work email address:<valueContactPoint xmlns="http://hl7.org/fhir"> <system value="email"/> <value value="example@workplace.nl"/> <use value="work"/> </valueContactPoint> | ||||
Invariants | Defined on this element 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() | (children().count() > id.count())) | ||||
40. PractitionerRole.availableTime | |||||
Definition | A collection of times that the Service Site is available. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Comments | More detailed availability information may be provided in associated Schedule/Slot resources. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
41. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
42. PractitionerRole.availableTime.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
43. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
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. | ||||
44. PractitionerRole.availableTime.daysOfWeek | |||||
Definition | Indicates which days of the week are available between the start and end Times. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from DaysOfWeek The days of the week | ||||
Type | code | ||||
45. PractitionerRole.availableTime.allDay | |||||
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
46. PractitionerRole.availableTime.availableStartTime | |||||
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored. | ||||
Control | 0..1 | ||||
Type | time | ||||
Comments | The timezone is expected to be for where this HealthcareService is provided at. | ||||
47. PractitionerRole.availableTime.availableEndTime | |||||
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored. | ||||
Control | 0..1 | ||||
Type | time | ||||
Comments | The timezone is expected to be for where this HealthcareService is provided at. | ||||
48. PractitionerRole.notAvailable | |||||
Definition | The HealthcareService is not available during this period of time due to the provided reason. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
49. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
50. PractitionerRole.notAvailable.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
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. | ||||
51. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
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. | ||||
52. PractitionerRole.notAvailable.description | |||||
Definition | The reason that can be presented to the user as to why this time is not available. | ||||
Control | 1..1 | ||||
Type | string | ||||
53. PractitionerRole.notAvailable.during | |||||
Definition | Service is not available (seasonally or for a public holiday) from this date. | ||||
Control | 0..1 | ||||
Type | Period | ||||
54. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
55. PractitionerRole.endpoint | |||||
Definition | Technical endpoints providing access to services operated for the practitioner with this role. | ||||
Control | 0..* | ||||
Type | Reference(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. |