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-relatedperson resource profile.
Guidance on how to interpret the contents of this table can be found here
0. RelatedPerson | |
2. RelatedPerson.extension | |
Slicing | This element introduces a set of slices on RelatedPerson.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
4. RelatedPerson.extension:role | |
Slice Name | role |
Definition | Defines the role of the contact in relation to the patient. |
Short | Role |
Type | Extension(nl-core-relatedperson-role) (Extension Type: CodeableConcept) |
Alternate Names | Rol |
6. RelatedPerson.extension:role.valueCodeableConcept:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
Binding | Unless not suitable, these codes SHALL be taken from RolCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20171231000000 ) |
8. RelatedPerson.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
10. RelatedPerson.patient | |
Type | Reference(nl-core-patient) |
12. RelatedPerson.relationship | |
Definition | Defines the contact’s familial relationship to the patient. |
Short | Relationship |
Binding | Unless not suitable, these codes SHALL be taken from RelatieCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20171231000000 ) |
Alternate Names | Relatie |
14. RelatedPerson.name | |
Definition | Full name of the contact. |
Short | NameInformation |
Type | HumanName(nl-core-humanname) |
Alternate Names | Naamgegevens |
16. RelatedPerson.telecom | |
Short | ContactInformation |
Type | ContactPoint(nl-core-contactpoint) |
Alternate Names | Contactgegevens |
18. RelatedPerson.address | |
Short | AddressInformation |
Type | Address(nl-core-address) |
Alternate Names | Adresgegevens |
20. RelatedPerson.period |
Guidance on how to interpret the contents of this table can be found here
0. RelatedPerson | |
Definition | Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. |
Short | An person that is related to a patient, but who is not a direct target of care |
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. RelatedPerson.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. RelatedPerson.extension | |
Definition | An Extension 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 | ExtensionAdditional 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 RelatedPerson.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
6. RelatedPerson.extension:role | |
Slice Name | role |
Definition | Defines the role of the contact in relation to the patient. |
Short | Role |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(nl-core-relatedperson-role) (Extension Type: CodeableConcept) |
Alternate Names | Rol |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
8. RelatedPerson.extension:role.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
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. |
Fixed Value | http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role |
10. RelatedPerson.extension:role.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 10..1 |
Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on RelatedPerson.extension.value[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: |
12. RelatedPerson.extension:role.value[x]:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | RoleValue of extension |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see RolCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20171231000000 ) |
Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Alternate Names | Rol |
14. RelatedPerson.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 |
16. RelatedPerson.identifier | |
Definition | Identifier for a person within a particular scope. |
Short | A human identifier for this person |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. |
18. RelatedPerson.active | |
Definition | Whether this related person record is in active use. |
Short | Whether this related person's record is in active use |
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
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 related person record as not to be used, such as if it was created in error. |
Default Value | true |
20. RelatedPerson.patient | |
Definition | The patient this person is related to. |
Short | The patient this person is related to |
Control | 1..1 |
Type | Reference(nl-core-patient, Patient) |
Summary | true |
Requirements | We need to know which patient this RelatedPerson is related to. |
22. RelatedPerson.relationship | |
Definition | Defines the contact’s familial relationship to the patient. The nature of the relationship between a patient and the related person. |
Short | RelationshipThe nature of the relationship |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from The codes SHOULD be taken from RelatieCodelijsthttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20171231000000 ) |
Type | CodeableConcept |
Summary | true |
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. |
Alternate Names | Relatie |
24. RelatedPerson.name | |
Definition | Full name of the contact. 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:
|
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | HumanName(nl-core-humanname) |
Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. |
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() ) |
26. RelatedPerson.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() ) |
28. RelatedPerson.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. Address where the related person can be contacted or visited. |
Short | AddressInformationAddress where the related person can be contacted or visited |
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 | Need to keep track where the related person can be contacted per postal mail or visited. |
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())) ) |
30. RelatedPerson.period | |
Definition | The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. |
Short | Period of time that this relationship is considered valid |
Control | 0..1 |
Type | Period |
Guidance on how to interpret the contents of this table can be found here
0. RelatedPerson | |||||
Definition | Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. | ||||
Short | An person that is related to a patient, but who is not a direct target of care | ||||
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. RelatedPerson.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. RelatedPerson.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. RelatedPerson.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. RelatedPerson.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. RelatedPerson.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. RelatedPerson.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. RelatedPerson.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on RelatedPerson.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
16. RelatedPerson.extension:role | |||||
Slice Name | role | ||||
Definition | Defines the role of the contact in relation to the patient. | ||||
Short | Role | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(nl-core-relatedperson-role) (Extension Type: CodeableConcept) | ||||
Alternate Names | Rol | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
18. RelatedPerson.extension:role.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. | ||||
20. RelatedPerson.extension:role.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 RelatedPerson.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
22. RelatedPerson.extension:role.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
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. | ||||
Fixed Value | http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role | ||||
24. RelatedPerson.extension:role.value[x] | |||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||
Short | Value of extension | ||||
Control | 1..1 | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Slicing | This element introduces a set of slices on RelatedPerson.extension.value[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: | ||||
26. RelatedPerson.extension:role.value[x]:valueCodeableConcept | |||||
Slice Name | valueCodeableConcept | ||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||
Short | Role | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from RolCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20171231000000 ) | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Alternate Names | Rol | ||||
28. RelatedPerson.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 | ||||
30. RelatedPerson.identifier | |||||
Definition | Identifier for a person within a particular scope. | ||||
Short | A human identifier for this person | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||
32. RelatedPerson.active | |||||
Definition | Whether this related person record is in active use. | ||||
Short | Whether this related person's record is in active use | ||||
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. | ||||
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 related person record as not to be used, such as if it was created in error. | ||||
Default Value | true | ||||
34. RelatedPerson.patient | |||||
Definition | The patient this person is related to. | ||||
Short | The patient this person is related to | ||||
Control | 1..1 | ||||
Type | Reference(nl-core-patient) | ||||
Summary | true | ||||
Requirements | We need to know which patient this RelatedPerson is related to. | ||||
36. RelatedPerson.relationship | |||||
Definition | Defines the contact’s familial relationship to the patient. | ||||
Short | Relationship | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from RelatieCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20171231000000 ) | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. | ||||
Alternate Names | Relatie | ||||
38. RelatedPerson.name | |||||
Definition | Full name of the contact. | ||||
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 | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. | ||||
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. RelatedPerson.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. RelatedPerson.gender | |||||
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. | ||||
Short | male | female | other | unknown | ||||
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. | ||||
44. RelatedPerson.birthDate | |||||
Definition | The date on which the related person was born. | ||||
Short | The date on which the related person was born | ||||
Control | 0..1 | ||||
Type | date | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
46. RelatedPerson.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 | Need to keep track where the related person can be contacted per postal mail or visited. | ||||
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. RelatedPerson.photo | |||||
Definition | Image of the person. | ||||
Short | Image of the person | ||||
Control | 0..* | ||||
Type | Attachment | ||||
Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. | ||||
50. RelatedPerson.period | |||||
Definition | The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. | ||||
Short | Period of time that this relationship is considered valid | ||||
Control | 0..1 | ||||
Type | Period |