Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build
Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-04-09 |
Definitions for the nl-core-person resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Person | |
2. Person.identifier | |
Definition | Identification of the person. This is different from the identification of the persons role as patient/practitioner/contact. Some identifiers however are both in practice like the Dutch burgerservicenummer. |
Short | Identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Alternate Names | Identificatienummer |
Slicing | This element introduces a set of slices on Person.identifier . The slices are unordered and Open, and can be differentiated using the following discriminators: |
4. Person.identifier:BSN | |
Slice Name | BSN |
Short | BSN |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Alternate Names | BSN |
6. Person.identifier:BSN.system | |
Control | 1..? |
Fixed Value | http://fhir.nl/fhir/NamingSystem/bsn |
8. Person.identifier:BSN.value | |
Short | BSN (Burgerservicenummer (Dutch person identification number)) |
Control | 1..? |
Alternate Names | BSN |
Example | <br/><b>Example of a burgerservicenummer</b>:123456782 |
10. Person.name | |
Short | NameInformation |
Type | HumanName(nl-core-humanname) |
Alternate Names | Naamgegevens |
12. Person.telecom | |
Short | ContactInformation |
Type | ContactPoint(nl-core-contactpoint) |
Alternate Names | Contactgegevens |
14. Person.gender | |
Short | Gender |
Alternate Names | Geslacht |
16. Person.birthDate | |
Short | Persons date of birth. An incomplete date, e.g. only year or only year + month, is permitted. |
Alternate Names | Geboortedatum |
18. Person.address | |
Short | AddressInformation |
Type | Address(nl-core-address) |
Alternate Names | Adresgegevens |
20. Person.managingOrganization | |
Type | Reference(nl-core-organization) |
22. Person.link | |
24. Person.link.target | |
Type | Reference(nl-core-patient, nl-core-practitioner, nl-core-relatedperson, nl-core-person) |
Guidance on how to interpret the contents of this table can be found here
0. Person | |
Definition | Demographics and administrative information about a person independent of a specific health-related context. |
Short | A generic person record |
Comments | The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare). |
Control | 0..* |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty() )dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
2. Person.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. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Control | 0..1 |
Type | uri |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
4. Person.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. |
Short | Extensions that cannot be ignored |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Alternate Names | extensions, user content |
6. Person.identifier | |
Definition | Identification of the person. This is different from the identification of the persons role as patient/practitioner/contact. Some identifiers however are both in practice like the Dutch burgerservicenummer. Identifier for a person within a particular scope. |
Short | IdentifierA human identifier for this person |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier. |
Alternate Names | Identificatienummer |
Slicing | This element introduces a set of slices on Person.identifier . The slices are unordered and Open, and can be differentiated using the following discriminators: |
8. Person.identifier:BSN | |
Slice Name | BSN |
Definition | Identifier for a person within a particular scope. |
Short | BSNA human identifier for this person |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1* |
Type | Identifier |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier. |
Alternate Names | BSN |
10. Person.identifier:BSN.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary (If known) |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use (required to http://hl7.org/fhir/ValueSet/identifier-use )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
12. Person.identifier:BSN.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Control | 10..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
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/bsn |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
14. Person.identifier:BSN.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Short | BSN (Burgerservicenummer (Dutch person identification number))The value that is unique |
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. |
Control | 10..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | BSN |
Example | <br/><b>General</b>:123456 <br/><b>Example of a burgerservicenummer</b>:123456782 |
16. Person.name | |
Definition | A human's name with the ability to identify parts and usage. A name associated with the person. |
Short | NameInformationA name associated with the person |
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 recieving 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:
Person may have multiple names with different uses or applicable periods. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | HumanName(nl-core-humanname) |
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
Alternate Names | Naamgegevens |
Example | <br/><b>Structured HumanName (preferred above unstructured)</b>:{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode" : "NL4" }], "text" : "Irma Jongeneel-de Haas", "family" : "Jongeneel-de Haas", "_family" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString" : "Jongeneel" }, { "url" : "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString" : "de" }, { "url" : "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString" : "Haas" }] }, "given" : ["Irma"], "_given" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode" : "CL" }] }] } <br/><b>Unstructured HumanName</b>:{ "text" : "Irma Jongeneel-de Haas" } |
Invariants | 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() ) |
18. Person.telecom | |
Definition | Contact information includes a person's telephone numbers en e-mail addresses. A contact detail for the person, e.g. a telephone number or an email address. |
Short | ContactInformationA contact detail for the person |
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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | ContactPoint(nl-core-contactpoint) |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Alternate Names | Contactgegevens |
Example | <br/><b>Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "work" } <br/><b>Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "mobile" } <br/><b>Primary Home Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Private email address</b>:{ "system" : "email", "value" : "giesput@myweb.nl", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )cpt-2: A system is required if a value is provided. ( value.empty() or system.exists() ) |
20. Person.gender | |
Definition | Administrative Gender. |
Short | Gendermale | female | other | unknown |
Comments | The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. |
Control | 0..1 |
Binding | The codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender (required to http://hl7.org/fhir/ValueSet/administrative-gender )The gender of a person used for administrative purposes. |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes. |
Alternate Names | Geslacht |
22. Person.birthDate | |
Definition | The birth date for the person. |
Short | Persons date of birth. An incomplete date, e.g. only year or only year + month, is permitted.The date on which the person was born |
Comments | At least an estimated year should be provided as a guess if the real DOB is unknown. |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues. |
Alternate Names | Geboortedatum |
24. Person.address | |
Definition | There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world and adds all relevant components to express Dutch addresses. A Dutch Address is a proper FHIR Address. Systems that do not understand any of the extensions, will be able to render and work with a Dutch address. 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. 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. The HCIM defines certain address types in the AdresSoortCodelijst. These do not all have a one to one mapping in the FHIR Address datatype. The following explains how to deal with that. In addition, there are the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType to define this relationship HCIM Postal Address maps to Address.type 'postal'; HCIM Primary Home Address maps to Address.extension:official 'true' + Address.use 'home' + Address.use.extension 'HP'; HCIM Visit Address (Woon-/verblijfadres) maps to Address.use 'home' + Address.type 'physical' + Address.use.extension 'PHYS'; HCIM Temporary Address maps to Address.use 'temp'; HCIM Work Place Address maps to Address.use 'work'; HCIM Vacation Home Address maps to Address.use 'temp' + Address.use.extension 'HV'. 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. One or more addresses for the person. |
Short | AddressInformationOne or more addresses for the person |
Comments | Note: address is for postal addresses, not physical locations. Person may have multiple addresses with different uses or applicable periods. |
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 | May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification. |
Alternate Names | AdresInformatie, Adresgegevens |
Example | <br/><b>Example of a vacation home address</b>:{ "extension" : [{ "url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean" : false }], "use" : "temp", "_use" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-AD-use", "valueCode" : "HV" }] }, "line" : ["Binnenkant 12A Hoog"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "12" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix", "valueString" : "A" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID", "valueString" : "Hoog" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1000AA", "country" : "NLD" } <br/><b>Example of a primary home address</b>:{ "extension" : [{ "url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean" : true }], "use" : "home", "line" : ["Binnenkant to 10"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator", "valueString" : "to" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "10" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1001AA", "country" : "NLD" } |
Invariants | 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())) ) |
26. Person.managingOrganization | |
Definition | The organization that is the custodian of the person record. |
Short | The organization that is the custodian of the person record |
Control | 0..1 |
Type | Reference(nl-core-organization, Organization) |
Summary | true |
Requirements | Need to know who recognizes this person record, manages and updates it. |
28. Person.active | |
Definition | Whether this person's record is in active use. |
Short | This person's record is in active use |
Control | 0..1 |
Type | boolean |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be able to mark a person record as not to be used because it was created in error. |
Guidance on how to interpret the contents of this table can be found here
0. Person | |||||
Definition | Demographics and administrative information about a person independent of a specific health-related context. | ||||
Short | A generic person record | ||||
Comments | The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare). | ||||
Control | 0..* | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty() ) | ||||
2. Person.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
4. Person.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. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
6. Person.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. | ||||
Short | A set of rules under which this content was created | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
8. Person.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
10. Person.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. | ||||
Short | Text summary of the resource, for human interpretation | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
12. Person.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. | ||||
Short | Contained, inline Resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. Person.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. | ||||
Short | Additional Content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
16. Person.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. | ||||
Short | Extensions that cannot be ignored | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Alternate Names | extensions, user content | ||||
18. Person.identifier | |||||
Definition | Identification of the person. This is different from the identification of the persons role as patient/practitioner/contact. Some identifiers however are both in practice like the Dutch burgerservicenummer. | ||||
Short | Identifier | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier. | ||||
Alternate Names | Identificatienummer | ||||
Slicing | This element introduces a set of slices on Person.identifier . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
20. Person.identifier:BSN | |||||
Slice Name | BSN | ||||
Definition | Identifier for a person within a particular scope. | ||||
Short | BSN | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier. | ||||
Alternate Names | BSN | ||||
22. Person.identifier:BSN.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
24. Person.identifier:BSN.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. | ||||
Short | Additional Content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on Person.identifier.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
26. Person.identifier:BSN.use | |||||
Definition | The purpose of this identifier. | ||||
Short | usual | official | temp | secondary (If known) | ||||
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. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
28. Person.identifier:BSN.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )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. | ||||
30. Person.identifier:BSN.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
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/bsn | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
32. Person.identifier:BSN.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | BSN (Burgerservicenummer (Dutch person identification number)) | ||||
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. | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | BSN | ||||
Example | <br/><b>General</b>:123456 <br/><b>Example of a burgerservicenummer</b>:123456782 | ||||
34. Person.identifier:BSN.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
36. Person.identifier:BSN.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
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. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
38. Person.name | |||||
Definition | A human's name with the ability to identify parts and usage. | ||||
Short | NameInformation | ||||
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 recieving 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:
| ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | HumanName(nl-core-humanname) | ||||
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. | ||||
Alternate Names | Naamgegevens | ||||
Example | <br/><b>Structured HumanName (preferred above unstructured)</b>:{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode" : "NL4" }], "text" : "Irma Jongeneel-de Haas", "family" : "Jongeneel-de Haas", "_family" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString" : "Jongeneel" }, { "url" : "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString" : "de" }, { "url" : "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString" : "Haas" }] }, "given" : ["Irma"], "_given" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode" : "CL" }] }] } <br/><b>Unstructured HumanName</b>:{ "text" : "Irma Jongeneel-de Haas" } | ||||
Invariants | 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() ) | ||||
40. Person.telecom | |||||
Definition | Contact information includes a person's telephone numbers en e-mail addresses. | ||||
Short | ContactInformation | ||||
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. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | ContactPoint(nl-core-contactpoint) | ||||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
Alternate Names | Contactgegevens | ||||
Example | <br/><b>Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "work" } <br/><b>Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "mobile" } <br/><b>Primary Home Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Land Line</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Fax</b>:{ "system" : "fax", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Mobile Phone</b>:{ "system" : "phone", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }] }, "value" : "...", "use" : "mobile", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Primary Home Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } <br/><b>Temporary Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "temp", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "TMP", "display" : "Temporary" }] } }] } } <br/><b>Primary Work Pager</b>:{ "system" : "pager", "_system" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }] }, "value" : "...", "use" : "work", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "WP", "display" : "Primary Work" }] } }] } } <br/><b>Private email address</b>:{ "system" : "email", "value" : "giesput@myweb.nl", "use" : "home", "_use" : { "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/code-specification", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Primary Home" }] } }] } } | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )cpt-2: A system is required if a value is provided. ( value.empty() or system.exists() ) | ||||
42. Person.gender | |||||
Definition | Administrative Gender. | ||||
Short | Gender | ||||
Comments | The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender )The gender of a person used for administrative purposes. | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes. | ||||
Alternate Names | Geslacht | ||||
44. Person.birthDate | |||||
Definition | The birth date for the person. | ||||
Short | Persons date of birth. An incomplete date, e.g. only year or only year + month, is permitted. | ||||
Comments | At least an estimated year should be provided as a guess if the real DOB is unknown. | ||||
Control | 0..1 | ||||
Type | date | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues. | ||||
Alternate Names | Geboortedatum | ||||
46. Person.address | |||||
Definition | There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world and adds all relevant components to express Dutch addresses. A Dutch Address is a proper FHIR Address. Systems that do not understand any of the extensions, will be able to render and work with a Dutch address. 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. 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. The HCIM defines certain address types in the AdresSoortCodelijst. These do not all have a one to one mapping in the FHIR Address datatype. The following explains how to deal with that. In addition, there are the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType to define this relationship HCIM Postal Address maps to Address.type 'postal'; HCIM Primary Home Address maps to Address.extension:official 'true' + Address.use 'home' + Address.use.extension 'HP'; HCIM Visit Address (Woon-/verblijfadres) maps to Address.use 'home' + Address.type 'physical' + Address.use.extension 'PHYS'; HCIM Temporary Address maps to Address.use 'temp'; HCIM Work Place Address maps to Address.use 'work'; HCIM Vacation Home Address maps to Address.use 'temp' + Address.use.extension 'HV'. 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. | ||||
Short | AddressInformation | ||||
Comments | Note: address is for postal addresses, not physical locations. | ||||
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 | May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification. | ||||
Alternate Names | AdresInformatie, Adresgegevens | ||||
Example | <br/><b>Example of a vacation home address</b>:{ "extension" : [{ "url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean" : false }], "use" : "temp", "_use" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-AD-use", "valueCode" : "HV" }] }, "line" : ["Binnenkant 12A Hoog"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "12" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix", "valueString" : "A" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID", "valueString" : "Hoog" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1000AA", "country" : "NLD" } <br/><b>Example of a primary home address</b>:{ "extension" : [{ "url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean" : true }], "use" : "home", "line" : ["Binnenkant to 10"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator", "valueString" : "to" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "10" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1001AA", "country" : "NLD" } | ||||
Invariants | 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())) ) | ||||
48. Person.photo | |||||
Definition | An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. | ||||
Short | Image of the person | ||||
Control | 0..1 | ||||
Type | Attachment | ||||
50. Person.managingOrganization | |||||
Definition | The organization that is the custodian of the person record. | ||||
Short | The organization that is the custodian of the person record | ||||
Control | 0..1 | ||||
Type | Reference(nl-core-organization) | ||||
Summary | true | ||||
Requirements | Need to know who recognizes this person record, manages and updates it. | ||||
52. Person.active | |||||
Definition | Whether this person's record is in active use. | ||||
Short | This person's record is in active use | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be able to mark a person record as not to be used because it was created in error. | ||||
54. Person.link | |||||
Definition | Link to a resource that concerns the same actual person. | ||||
Short | Link to a resource that concerns the same actual person | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) | ||||
56. Person.link.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
58. Person.link.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. | ||||
Short | Additional Content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
60. Person.link.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. | ||||
Short | Extensions that cannot be ignored | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
62. Person.link.target | |||||
Definition | The resource to which this actual person is associated. | ||||
Short | The resource to which this actual person is associated | ||||
Control | 1..1 | ||||
Type | Reference(nl-core-patient, nl-core-practitioner, nl-core-relatedperson, nl-core-person) | ||||
64. Person.link.assurance | |||||
Definition | Level of assurance that this link is actually associated with the target resource. | ||||
Short | level1 | level2 | level3 | level4 | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentityAssuranceLevel (required to http://hl7.org/fhir/ValueSet/identity-assuranceLevel )The level of confidence that this link represents the same actual person, based on NIST Authentication Levels. | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |