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 Practitioner resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Practitioner | |
2. Practitioner.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..* |
Invariants | Defined on this element zv-pra-3: Either Practitioner BIG or AGB-Z identifier SHALL be present. (: (identifier.exists())) |
3. Practitioner.identifier:AGB | |
SliceName | AGB |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
4. Practitioner.identifier:BIG | |
SliceName | BIG |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
5. Practitioner.name | |
Control | 10..* |
Must Support | true |
Invariants | Defined on this element zv-pra-1: Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. (: (family.exists() or given.exists() or text.exists())) zv-pra-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. (: text.exists()) |
Guidance on how to interpret the contents of this table can be found here.
1. Practitioner | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. |
Control | 0..* |
Alternate Names | Zorgverlener |
Comments | Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual? |
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. Practitioner.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. Practitioner.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. Practitioner.identifier | |
Definition | The health professional identification number is a number that uniquely identifies the health professional. The following numbers are used in the Netherlands: 1. UZI Health Professionals. Identification of health professionals (people) in the Dutch healthcare industry. 2. VEKTIS AGB-Z. Identifies health professionals and healthcare organizations. 3. BIG-ID. The ID of the health professional listed in the BIG Register. This information is not readily available for foreign health professionals. An identifier that applies to this person in this role. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..* |
Type | Identifier |
Summary | true |
Requirements | Often, specific identities are assigned for the agent. |
Alternate Names | ZorgverlenerIdentificatieNummer |
Invariants | Defined on this element zv-pra-3: Either Practitioner BIG or AGB-Z identifier SHALL be present. (: (identifier.exists())) |
Slicing | This element introduces a set of slices on Practitioner.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
5. Practitioner.identifier:UZI | |
SliceName | UZI |
Definition | Unieke Zorgverlener Identificatie (Dutch physician identification number) An identifier that applies to this person in this role. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1* |
Type | Identifier |
Summary | true |
Requirements | Often, specific identities are assigned for the agent. |
Alternate Names | UZI |
6. Practitioner.identifier:UZI.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
7. Practitioner.identifier:UZI.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 10..1 |
Type | uri |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Fixed Value | http://fhir.nl/fhir/NamingSystem/uzi-nr-pers |
Example | General:http://www.acme.com/identifiers/patient |
8. Practitioner.identifier:UZI.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 10..1 |
Type | string |
Summary | true |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
Example | General:123456 Example:01011234 |
9. Practitioner.identifier:AGB | |
SliceName | AGB |
Definition | An identifier that applies to this person in this role. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1* |
Type | Identifier |
Must Support | true |
Summary | true |
Requirements | Often, specific identities are assigned for the agent. |
Alternate Names | AGB |
10. Practitioner.identifier:AGB.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
11. Practitioner.identifier:AGB.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 10..1 |
Type | uri |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Fixed Value | http://fhir.nl/fhir/NamingSystem/agb-z |
Example | General:http://www.acme.com/identifiers/patient |
12. Practitioner.identifier:AGB.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 10..1 |
Type | string |
Summary | true |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
Example | General:123456 Example:123456 |
13. Practitioner.identifier:BIG | |
SliceName | BIG |
Definition | An identifier that applies to this person in this role. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1* |
Type | Identifier |
Must Support | true |
Summary | true |
Requirements | Often, specific identities are assigned for the agent. |
Alternate Names | BIG |
14. Practitioner.identifier:BIG.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
15. Practitioner.identifier:BIG.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 10..1 |
Type | uri |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Fixed Value | http://fhir.nl/fhir/NamingSystem/big |
Example | General:http://www.acme.com/identifiers/patient |
16. Practitioner.identifier:BIG.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 10..1 |
Type | string |
Summary | true |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
Example | General:123456 Example:12345678 |
17. Practitioner.name | |
Definition | Health professional’s full name. If a health professional identification number is entered, it will be the name as listed in UZI, AGB or by the healthcare center. The name(s) associated with the practitioner. |
Control | 10..* This element is affected by the following invariants: ele-1 |
Type | HumanName(nl-core-humanname) |
Must Support | true |
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. |
Alternate Names | Naamgegevens |
Comments | Dutch names require that certain name parts are separately communicable. For this reason, extensions are added onto the base HumanName element to mark the meaning of each part. A Dutch HumanName is still a proper FHIR HumanName; however, there might be an incompatibilty with the default FHIR mechanism for communicating given names. See the compatibility note below for more information. The extension elements cover birth name (NL: eigennaam / geslachtsnaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. Incompatibility note: It has come to light that this specification deviates from the way that the HumanName datatype is normally used. This will be fixed in a future release. However, current implementations should be aware of the special considerations regarding the use of this specification. The issue at hand is the way alternative representations of a name, like initials or a nickname, are communicated. Normally this is done using multiple HumanName instances, which are differentiated using the Since multiple implementations are based on this specification, sending systems are advised (but not required) to keep the approach with one HumanName instance, while receiving systems should be able to handle this one-instance approach. More specifically:
Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas:
The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general select the value to be used in the ResourceReference.display based on this:
|
Example | Structured HumanName (preferred above unstructured):<valueHumanName xmlns="http://hl7.org/fhir"> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"> <valueCode value="NL4"/> </extension> <text value="Irma Jongeneel-de Haas"/> <family value="Jongeneel-de Haas"> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name"> <valueString value="Jongeneel"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"> <valueString value="de"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-partner-name"> <valueString value="Haas"/> </extension> </family> <given value="Irma"/> </valueHumanName> Unstructured HumanName:<valueHumanName xmlns="http://hl7.org/fhir"> <text value="Irma Jongeneel-de Haas"/> </valueHumanName> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected (: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()) nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected (: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()) zv-pra-1: Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. (: (family.exists() or given.exists() or text.exists())) zv-pra-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. (: text.exists()) |
18. Practitioner.address | |
Definition | This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the HCIM AddressInformation (v1.0, 2017). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements. Separate address parts The first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad. Custom address types The second addition is that the HCIM defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the HCIM concepts are mapped to the various FHIR elements (see the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType as well). The HCIM code itself should also be included using the AddressType extension. | HCIM | If Address.type is both then this is to be understood as a dual purpose address (postal and physical). Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses. NOTE: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. |
Control | 0..* This element is affected by the following invariants: ele-1, nl-streetname-if-official-and-other-line-parts |
Type | Address(nl-core-address) |
Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. |
Alternate Names | AdresInformatie, Adresgegevens |
Comments | Note: address is for postal addresses, not physical locations. The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). |
Example | Example of a Vacation Home address:<valueAddress xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/v3/AddressUse"/> <code value="HV"/> <display value="Vakantie adres"/> </coding> </valueCodeableConcept> </extension> <use value="temp"/> <line value="Binnenkant 12A Hoog"/> <city value="Amsterdam"/> <state value="NH"/> <postalCode value="1000AA"/> <country value="NLD"/> </valueAddress> Example of a Primary Home address:<valueAddress xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/v3/AddressUse"/> <code value="HP"/> <display value="Officieel adres"/> </coding> </valueCodeableConcept> </extension> <extension url="http://fhir.nl/fhir/StructureDefinition/nl-core-address-official"> <valueBoolean value="true"/> </extension> <use value="home"/> <line value="Binnenkant to 10"/> <city value="Amsterdam"/> <state value="NH"/> <postalCode value="1001AA"/> <country value="NLD"/> </valueAddress> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value (: (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))) |
Guidance on how to interpret the contents of this table can be found here.
1. Practitioner | |||||
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. | ||||
Control | 0..* | ||||
Alternate Names | Zorgverlener | ||||
Comments | Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual? | ||||
2. Practitioner.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. Practitioner.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. Practitioner.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. Practitioner.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. Practitioner.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. Practitioner.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. Practitioner.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. Practitioner.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. Practitioner.identifier | |||||
Definition | The health professional identification number is a number that uniquely identifies the health professional. The following numbers are used in the Netherlands: 1. UZI Health Professionals. Identification of health professionals (people) in the Dutch healthcare industry. 2. VEKTIS AGB-Z. Identifies health professionals and healthcare organizations. 3. BIG-ID. The ID of the health professional listed in the BIG Register. This information is not readily available for foreign health professionals. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 1..* | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Often, specific identities are assigned for the agent. | ||||
Alternate Names | ZorgverlenerIdentificatieNummer | ||||
Invariants | Defined on this element zv-pra-3: Either Practitioner BIG or AGB-Z identifier SHALL be present. (: (identifier.exists())) | ||||
Slicing | This element introduces a set of slices on Practitioner.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
11. Practitioner.identifier:UZI | |||||
SliceName | UZI | ||||
Definition | Unieke Zorgverlener Identificatie (Dutch physician identification number) | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Often, specific identities are assigned for the agent. | ||||
Alternate Names | UZI | ||||
12. Practitioner.identifier:UZI.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. | ||||
13. Practitioner.identifier:UZI.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 Practitioner.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
14. Practitioner.identifier:UZI.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
15. Practitioner.identifier:UZI.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
16. Practitioner.identifier:UZI.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Fixed Value | http://fhir.nl/fhir/NamingSystem/uzi-nr-pers | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
17. Practitioner.identifier:UZI.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||||
Example | General:123456 Example:01011234 | ||||
18. Practitioner.identifier:UZI.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
19. Practitioner.identifier:UZI.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
20. Practitioner.identifier:AGB | |||||
SliceName | AGB | ||||
Definition | An identifier that applies to this person in this role. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Often, specific identities are assigned for the agent. | ||||
Alternate Names | AGB | ||||
21. Practitioner.identifier:AGB.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. Practitioner.identifier:AGB.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 Practitioner.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
23. Practitioner.identifier:AGB.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
24. Practitioner.identifier:AGB.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
25. Practitioner.identifier:AGB.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Fixed Value | http://fhir.nl/fhir/NamingSystem/agb-z | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
26. Practitioner.identifier:AGB.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||||
Example | General:123456 Example:123456 | ||||
27. Practitioner.identifier:AGB.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
28. Practitioner.identifier:AGB.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
29. Practitioner.identifier:BIG | |||||
SliceName | BIG | ||||
Definition | An identifier that applies to this person in this role. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Often, specific identities are assigned for the agent. | ||||
Alternate Names | BIG | ||||
30. Practitioner.identifier:BIG.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. | ||||
31. Practitioner.identifier:BIG.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 Practitioner.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
32. Practitioner.identifier:BIG.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
33. Practitioner.identifier:BIG.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
34. Practitioner.identifier:BIG.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Fixed Value | http://fhir.nl/fhir/NamingSystem/big | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
35. Practitioner.identifier:BIG.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||||
Example | General:123456 Example:12345678 | ||||
36. Practitioner.identifier:BIG.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
37. Practitioner.identifier:BIG.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
38. Practitioner.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 | ||||
39. Practitioner.name | |||||
Definition | Health professional’s full name. If a health professional identification number is entered, it will be the name as listed in UZI, AGB or by the healthcare center. | ||||
Control | 1..* This element is affected by the following invariants: ele-1 | ||||
Type | HumanName(nl-core-humanname) | ||||
Must Support | true | ||||
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. | ||||
Alternate Names | Naamgegevens | ||||
Comments | Dutch names require that certain name parts are separately communicable. For this reason, extensions are added onto the base HumanName element to mark the meaning of each part. A Dutch HumanName is still a proper FHIR HumanName; however, there might be an incompatibilty with the default FHIR mechanism for communicating given names. See the compatibility note below for more information. The extension elements cover birth name (NL: eigennaam / geslachtsnaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. Incompatibility note: It has come to light that this specification deviates from the way that the HumanName datatype is normally used. This will be fixed in a future release. However, current implementations should be aware of the special considerations regarding the use of this specification. The issue at hand is the way alternative representations of a name, like initials or a nickname, are communicated. Normally this is done using multiple HumanName instances, which are differentiated using the Since multiple implementations are based on this specification, sending systems are advised (but not required) to keep the approach with one HumanName instance, while receiving systems should be able to handle this one-instance approach. More specifically:
Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas:
| ||||
Example | Structured HumanName (preferred above unstructured):<valueHumanName xmlns="http://hl7.org/fhir"> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"> <valueCode value="NL4"/> </extension> <text value="Irma Jongeneel-de Haas"/> <family value="Jongeneel-de Haas"> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name"> <valueString value="Jongeneel"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"> <valueString value="de"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-partner-name"> <valueString value="Haas"/> </extension> </family> <given value="Irma"/> </valueHumanName> Unstructured HumanName:<valueHumanName xmlns="http://hl7.org/fhir"> <text value="Irma Jongeneel-de Haas"/> </valueHumanName> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected (: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()) nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected (: name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()) zv-pra-1: Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. (: (family.exists() or given.exists() or text.exists())) zv-pra-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. (: text.exists()) | ||||
40. Practitioner.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 | Need to know how to reach a practitioner independent to any roles the practitioner may have. | ||||
Alternate Names | Contactgegevens | ||||
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification These typically will have home numbers, or mobile numbers that are not role specific. | ||||
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())) | ||||
41. Practitioner.address | |||||
Definition | This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the HCIM AddressInformation (v1.0, 2017). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements. Separate address parts The first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad. Custom address types The second addition is that the HCIM defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the HCIM concepts are mapped to the various FHIR elements (see the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType as well). The HCIM code itself should also be included using the AddressType extension. | HCIM | If Address.type is both then this is to be understood as a dual purpose address (postal and physical). Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses. NOTE: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension. | ||||
Control | 0..* This element is affected by the following invariants: ele-1, nl-streetname-if-official-and-other-line-parts | ||||
Type | Address(nl-core-address) | ||||
Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. | ||||
Alternate Names | AdresInformatie, Adresgegevens | ||||
Comments | Note: address is for postal addresses, not physical locations. | ||||
Example | Example of a Vacation Home address:<valueAddress xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/v3/AddressUse"/> <code value="HV"/> <display value="Vakantie adres"/> </coding> </valueCodeableConcept> </extension> <use value="temp"/> <line value="Binnenkant 12A Hoog"/> <city value="Amsterdam"/> <state value="NH"/> <postalCode value="1000AA"/> <country value="NLD"/> </valueAddress> Example of a Primary Home address:<valueAddress xmlns="http://hl7.org/fhir"> <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType"> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/v3/AddressUse"/> <code value="HP"/> <display value="Officieel adres"/> </coding> </valueCodeableConcept> </extension> <extension url="http://fhir.nl/fhir/StructureDefinition/nl-core-address-official"> <valueBoolean value="true"/> </extension> <use value="home"/> <line value="Binnenkant to 10"/> <city value="Amsterdam"/> <state value="NH"/> <postalCode value="1001AA"/> <country value="NLD"/> </valueAddress> | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value (: (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))) | ||||
42. Practitioner.gender | |||||
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AdministrativeGender The gender of a person used for administrative purposes | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Needed to address the person correctly. | ||||
43. Practitioner.birthDate | |||||
Definition | The date of birth for the practitioner. | ||||
Control | 0..1 | ||||
Type | date | ||||
Summary | true | ||||
Requirements | Needed for identification. | ||||
44. Practitioner.photo | |||||
Definition | Image of the person. | ||||
Control | 0..* | ||||
Type | Attachment | ||||
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. | ||||
45. Practitioner.qualification | |||||
Definition | Qualifications obtained by training and certification. | ||||
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())) | ||||
46. Practitioner.qualification.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. | ||||
47. Practitioner.qualification.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. | ||||
48. Practitioner.qualification.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. | ||||
49. Practitioner.qualification.identifier | |||||
Definition | An identifier that applies to this person's qualification in this role. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Requirements | Often, specific identities are assigned for the qualification. | ||||
50. Practitioner.qualification.code | |||||
Definition | Coded representation of the qualification. | ||||
Control | 1..1 | ||||
Binding | For example codes, see v2 table 0360, Version 2.7 Specific qualification the practitioner has to provide a servic | ||||
Type | CodeableConcept | ||||
51. Practitioner.qualification.period | |||||
Definition | Period during which the qualification is valid. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Requirements | Qualifications are often for a limited period of time, and can be revoked. | ||||
52. Practitioner.qualification.issuer | |||||
Definition | Organization that regulates and issues the qualification. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
53. Practitioner.communication | |||||
Definition | A language the practitioner is able to use in patient communication. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
A human language
| ||||
Type | CodeableConcept | ||||
Requirements | Knowing which language a practitioner speaks can help in facilitating communication with patients. | ||||
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. |