{
"description": null,
"_filename": "KT2RelatedPerson.json",
"package_name": "koppeltaalv2.00",
"date": null,
"derivation": "constraint",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "KT2_RelatedPerson",
"abstract": false,
"type": "RelatedPerson",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.14.0-beta.9",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
} ],
"path": "RelatedPerson",
"min": 0,
"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": "Contact",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "role",
"identity": "rim"
}, {
"map": "NL-CM:3.1.1",
"comment": "Contact",
"identity": "zib-contactperson-v3.4-2020EN"
} ],
"alias": [ "Contactpersoon", "nl-core-ContactPerson" ],
"max": "*",
"id": "RelatedPerson",
"comment": "Whereas the zib ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons:\r\n\r\n* The RelatedPerson resource, and therefore this profile, is used to capture information about any person that is related to the patient.\r\n* Information about persons that should be _contacted_ regarding the care for the patient is captured using the `Patient.contact` resource.\r\n\r\nIf a person is both a related person and a contact person, then some data duplication is inevitable.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson"
}
}, {
"path": "RelatedPerson.id",
"min": 0,
"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",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"max": "1",
"id": "RelatedPerson.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Meta"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "RelatedPerson.meta",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "RelatedPerson.implicitRules",
"condition": [ "ele-1" ],
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "RelatedPerson.language",
"condition": [ "ele-1" ],
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "RelatedPerson.text",
"condition": [ "ele-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "RelatedPerson.contained",
"min": 0,
"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",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "RelatedPerson.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "RelatedPerson.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RelatedPerson.extension",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "RelatedPerson.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RelatedPerson.modifierExtension",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them"
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.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 patient. Examples are national person identifier and local identifier.",
"min": 1,
"definition": "Identifier for a person within a particular scope.",
"short": "A human identifier for this person",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "NK1-33",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "*",
"id": "RelatedPerson.identifier",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.active",
"requirements": "Need to be able to mark a related person record as not to be used, such as if it was created in error.",
"min": 1,
"definition": "Whether this related person record is in active use.",
"isModifier": true,
"short": "Whether this related person's record is in active use",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": ".statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element",
"max": "1",
"id": "RelatedPerson.active",
"condition": [ "ele-1" ],
"comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"base": {
"max": "1",
"min": 0,
"path": "RelatedPerson.active"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))"
} ],
"path": "RelatedPerson.patient",
"requirements": "We need to know which patient this RelatedPerson is related to.",
"min": 1,
"definition": "The patient this person is related to.",
"short": "The patient this person is related to",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "PID-3",
"identity": "v2"
}, {
"map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://koppeltaal.nl/fhir/StructureDefinition/KT2Patient" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "RelatedPerson.patient",
"condition": [ "ele-1" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 1,
"path": "RelatedPerson.patient"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.relationship",
"requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.",
"min": 1,
"definition": "The nature of the relationship between a patient and the related person.",
"short": "The nature of the relationship",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
},
"type": [ {
"code": "CodeableConcept"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PatientRelationshipType"
} ],
"description": "The nature of the relationship between a patient and the related person."
},
"max": "*",
"id": "RelatedPerson.relationship",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.relationship"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.relationship",
"requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.",
"min": 0,
"definition": "Defines the role of the contact in relation to the patient.",
"short": "Role",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
}, {
"map": "NL-CM:3.1.2",
"comment": "Role",
"identity": "zib-contactperson-v3.4-2020EN"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "role",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "required",
"valueSet": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PatientRelationshipType"
} ],
"description": "The nature of the relationship between a patient and the related person."
},
"alias": [ "Rol" ],
"max": "*",
"id": "RelatedPerson.relationship:role",
"condition": [ "ele-1" ],
"comment": "DO NOT use codes 23 or 24 of the code system defined in this slice to express these roles. Use the code system provided in the `customRole` slice.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.relationship"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.relationship",
"requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.",
"min": 0,
"definition": "Defines the contact’s familial relationship to the patient.",
"short": "Relationship",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
}, {
"map": "NL-CM:3.1.3",
"comment": "Relationship",
"identity": "zib-contactperson-v3.4-2020EN"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "relationship",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "required",
"valueSet": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PatientRelationshipType"
} ],
"description": "The nature of the relationship between a patient and the related person."
},
"alias": [ "Relatie" ],
"max": "*",
"id": "RelatedPerson.relationship:relationship",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.relationship"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.relationship",
"requirements": "This slice is included only as a emporary solution to provide missing codes. See KOP-864.",
"min": 0,
"definition": "Definition of the relationship if the relation is contact person or legal guardian.",
"short": "Custom role",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "customRole",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://vzvz.nl/fhir/ValueSet/koppeltaal-custom-roles",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PatientRelationshipType"
} ],
"description": "The nature of the relationship between a patient and the related person."
},
"max": "*",
"id": "RelatedPerson.relationship:customRole",
"condition": [ "ele-1" ],
"comment": "Use this slice ONLY to express contact person or legal guardian. DO NOT use codes 23 or 24 of the code system defined in the `role` slice to express these roles.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.relationship"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.name",
"requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.",
"min": 1,
"definition": "Full name of the contact.",
"short": "NameInformation / PayerName",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN",
"identity": "v2"
}, {
"map": "EN (actually, PN)",
"identity": "rim"
}, {
"map": "ProviderName",
"identity": "servd"
}, {
"map": "NK1-2",
"identity": "v2"
}, {
"map": "name",
"identity": "rim"
}, {
"map": "NL-CM:3.1.4",
"comment": "NameInformation",
"identity": "zib-contactperson-v3.4-2020EN"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "zib-payer-v3.1.1-2020EN"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "use",
"type": "value"
} ]
},
"type": [ {
"code": "HumanName"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "Naamgegevens", "BetalerNaam" ],
"max": "*",
"id": "RelatedPerson.name",
"condition": [ "ele-1" ],
"comment": "Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "zib-NameInformation-1",
"human": "If a prefix for a family name is specified, the family name is expected as well",
"source": "http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation",
"severity": "error",
"expression": "family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()"
}, {
"key": "zib-NameInformation-2",
"human": "If the prefix for a partner family name is specified, the partner family name is expected as well",
"source": "http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation",
"severity": "error",
"expression": "family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()"
} ],
"path": "RelatedPerson.name",
"requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.",
"min": 0,
"definition": "This slice represents the person's official name information, including given names, last name and possibly the partner's last name.",
"short": "NameInformation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN",
"identity": "v2"
}, {
"map": "EN (actually, PN)",
"identity": "rim"
}, {
"map": "ProviderName",
"identity": "servd"
}, {
"map": "NK1-2",
"identity": "v2"
}, {
"map": "name",
"identity": "rim"
}, {
"map": "NL-CM:20.4.1",
"comment": "NameInformation",
"identity": "zib-nameinformation-v1.1-2020EN"
} ],
"type": [ {
"code": "HumanName",
"profile": [ "http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation" ]
} ],
"sliceName": "nameInformation",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "Naamgegevens", "nl-core-NameInformation" ],
"max": "2",
"id": "RelatedPerson.name:nameInformation",
"condition": [ "ele-1" ],
"comment": "This `.name` element represents a Dutch name according to the [zib NameInformation (v1.1, 2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)) (except for the GivenName concept). A Dutch name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Dutch rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Dutch context **MUST** support these extensions as specified here. In addition, systems **MUST** use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. It is encouraged to provide a representation of the full name in the `.text` element.\r\n\r\n**Note 1**: The zib cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept.\r\n\r\n**Note 2**: This element should only contain a person's _official_ names. The GivenName concept is represented in another `.name` element with `.name.use` = _usual_.\r\n\r\n**Note 3**: The examples illustrate how the zib is mapped to FHIR.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.name",
"requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.",
"min": 0,
"definition": "This slice represents the name information normally used to address the person.",
"short": "Name of a human - parts and usage",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN",
"identity": "v2"
}, {
"map": "EN (actually, PN)",
"identity": "rim"
}, {
"map": "ProviderName",
"identity": "servd"
}, {
"map": "NK1-2",
"identity": "v2"
}, {
"map": "name",
"identity": "rim"
} ],
"type": [ {
"code": "HumanName",
"profile": [ "http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation.GivenName" ]
} ],
"sliceName": "nameInformation-GivenName",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "nl-core-NameInformation.GivenName" ],
"max": "*",
"id": "RelatedPerson.name:nameInformation-GivenName",
"condition": [ "ele-1" ],
"comment": "This `.name` element represents the Dutch given name (\"roepnaam\") according to the [zib NameInformation v1.1 (2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)).\r\n\r\n**Note 1**: This element should only contain a person's _unofficial_ name. The official names are represented in one or more other `.name` elements with `.name.use` = _official_.\r\n\r\n**Note 2**: The examples illustrate how the zib is mapped to FHIR.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cpt-2",
"human": "A system is required if a value is provided.",
"xpath": "not(exists(f:value)) or exists(f:system)",
"source": "http://hl7.org/fhir/StructureDefinition/ContactPoint",
"severity": "error",
"expression": "value.empty() or system.exists()"
} ],
"path": "RelatedPerson.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "The contact’s telephone number and/or e-mail address.",
"short": "ContactInformation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XTN",
"identity": "v2"
}, {
"map": "TEL",
"identity": "rim"
}, {
"map": "ContactPoint",
"identity": "servd"
}, {
"map": "NK1-5 / NK1-6 / NK1-40",
"identity": "v2"
}, {
"map": "telecom",
"identity": "rim"
}, {
"map": "NL-CM:3.1.6",
"comment": "ContactInformation",
"identity": "zib-contactperson-v3.4-2020EN"
}, {
"map": "NL-CM:20.6.1",
"comment": "ContactInformation",
"identity": "zib-contactinformation-v1.2-2020EN"
}, {
"map": "NL-CM:1.1.12",
"comment": "ContactInformation",
"identity": "zib-payer-v3.1.1-2020EN"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "profile"
} ]
},
"type": [ {
"code": "ContactPoint"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "Contactgegevens" ],
"max": "*",
"id": "RelatedPerson.telecom",
"condition": [ "ele-1" ],
"comment": "The cardinality mismatch between the zib (0..1) and FHIR (0..*) is explained by the containers TelephoneNumbers (0..*) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.telecom"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cpt-2",
"human": "A system is required if a value is provided.",
"xpath": "not(exists(f:value)) or exists(f:system)",
"source": "http://hl7.org/fhir/StructureDefinition/ContactPoint",
"severity": "error",
"expression": "value.empty() or system.exists()"
} ],
"path": "RelatedPerson.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.",
"short": "TelephoneNumbers",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XTN",
"identity": "v2"
}, {
"map": "TEL",
"identity": "rim"
}, {
"map": "ContactPoint",
"identity": "servd"
}, {
"map": "NK1-5 / NK1-6 / NK1-40",
"identity": "v2"
}, {
"map": "telecom",
"identity": "rim"
}, {
"map": "NL-CM:20.6.2",
"comment": "TelephoneNumbers",
"identity": "zib-contactinformation-v1.2-2020EN"
} ],
"type": [ {
"code": "ContactPoint",
"profile": [ "http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactInformation-TelephoneNumbers" ]
} ],
"sliceName": "telephoneNumbers",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "Telefoonnummers", "nl-core-ContactInformation-TelephoneNumbers" ],
"max": "*",
"id": "RelatedPerson.telecom:telephoneNumbers",
"condition": [ "ele-1" ],
"comment": "Implementation of the \"TelephoneNumbers\" concept of zib ContactInformation.\r\n\r\nPlease note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the zib uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the zib code will need to be communicated using the ext-CodeSpecification extension.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.telecom"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cpt-2",
"human": "A system is required if a value is provided.",
"xpath": "not(exists(f:value)) or exists(f:system)",
"source": "http://hl7.org/fhir/StructureDefinition/ContactPoint",
"severity": "error",
"expression": "value.empty() or system.exists()"
} ],
"path": "RelatedPerson.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.",
"short": "EmailAddresses",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XTN",
"identity": "v2"
}, {
"map": "TEL",
"identity": "rim"
}, {
"map": "ContactPoint",
"identity": "servd"
}, {
"map": "NK1-5 / NK1-6 / NK1-40",
"identity": "v2"
}, {
"map": "telecom",
"identity": "rim"
}, {
"map": "NL-CM:20.6.3",
"comment": "EmailAddresses",
"identity": "zib-contactinformation-v1.2-2020EN"
} ],
"type": [ {
"code": "ContactPoint",
"profile": [ "http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactInformation-EmailAddresses" ]
} ],
"sliceName": "emailAddresses",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "EmailAdressen", "nl-core-ContactInformation-EmailAddresses" ],
"max": "*",
"id": "RelatedPerson.telecom:emailAddresses",
"condition": [ "ele-1" ],
"comment": "Implementation of the \"EmailAddresses\" concept of zib ContactInformation.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.telecom"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.gender",
"requirements": "Needed for identification of the person, in combination with (at least) name and birth date.",
"min": 1,
"definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"short": "male | female | other | unknown",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "NK1-15",
"identity": "v2"
}, {
"map": "administrativeGender",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The gender of a person used for administrative purposes."
},
"max": "1",
"id": "RelatedPerson.gender",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "RelatedPerson.gender"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.birthDate",
"min": 1,
"definition": "The date on which the related person was born.",
"short": "The date on which the related person was born",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "player.birthTime",
"identity": "rim"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "RelatedPerson.birthDate",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "RelatedPerson.birthDate"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.address",
"requirements": "Need to keep track where the related person can be contacted per postal mail or visited.",
"min": 0,
"definition": "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.",
"short": "AddressInformation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD",
"identity": "v2"
}, {
"map": "AD",
"identity": "rim"
}, {
"map": "Address",
"identity": "servd"
}, {
"map": "NK1-4",
"identity": "v2"
}, {
"map": "addr",
"identity": "rim"
}, {
"map": "NL-CM:20.5.1",
"comment": "AddressInformation",
"identity": "zib-addressinformation-v1.1-2020EN"
}, {
"map": "NL-CM:3.1.5",
"comment": "AddressInformation",
"identity": "zib-contactperson-v3.4-2020EN"
}, {
"map": "NL-CM:1.1.17",
"comment": "AddressInformation",
"identity": "zib-payer-v3.1.1-2020EN"
} ],
"type": [ {
"code": "Address",
"profile": [ "http://nictiz.nl/fhir/StructureDefinition/nl-core-AddressInformation" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "Adresgegevens", "nl-core-AddressInformation" ],
"max": "*",
"id": "RelatedPerson.address",
"condition": [ "ele-1" ],
"comment": "This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the [zib AddressInformation v1.1 (2020)](https://zibs.nl/wiki/AddressInformation-v1.1(2020EN)). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype.\r\n\r\nTo 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.\r\n\r\n**Separate address parts**\r\n\r\nThe first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad.\r\n\r\n**Custom address types**\r\n\r\nThe second addition is that the zib defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the zib concepts are mapped to the various FHIR elements (see the ConceptMaps and as well). The code from the zib should also be included using the extension on `Address.extension:addressType`.\r\n\r\n| zib | .ext:addressType | .use | .type |\r\n|-----------------------------------|------------------|------|----------|\r\n| Postal Address/Postadres | PST | | postal |\r\n| Primary Home/Officieel adres | HP | home | both |\r\n| Visit Address/Woon-/verblijfadres | PHYS | home | physical |\r\n| Temporary Address/Tijdelijk adres | TMP | temp | |\r\n| Work Place/Werkadres | WP | work | |\r\n| Vacation Home/Vakantie adres | HV | temp | |\r\n\r\nIf `Address.type` is _both_ then this is to be understood as a dual purpose address (postal and physical), unless a specific _postal_ type address is added. Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses.\r\n\r\nNote: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the zib ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.address"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "att-1",
"human": "If the Attachment has data, it SHALL have a contentType",
"xpath": "not(exists(f:data)) or exists(f:contentType)",
"source": "http://hl7.org/fhir/StructureDefinition/Attachment",
"severity": "error",
"expression": "data.empty() or contentType.exists()"
} ],
"path": "RelatedPerson.photo",
"requirements": "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.",
"min": 0,
"definition": "Image of the person.",
"short": "Image of the person",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED/RP",
"identity": "v2"
}, {
"map": "ED",
"identity": "rim"
}, {
"map": "OBX-5 - needs a profile",
"identity": "v2"
}, {
"map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc",
"identity": "rim"
} ],
"type": [ {
"code": "Attachment"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "RelatedPerson.photo",
"condition": [ "ele-1" ],
"comment": "When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as \"Signed Procedure Consent\".",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.photo"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower value than end",
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source": "http://hl7.org/fhir/StructureDefinition/Period",
"severity": "error",
"expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)"
} ],
"path": "RelatedPerson.period",
"min": 0,
"definition": "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.",
"short": "Period of time that this relationship is considered valid",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "DR",
"identity": "v2"
}, {
"map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
"identity": "rim"
}, {
"map": "FiveWs.done[x]",
"identity": "w5"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "RelatedPerson.period",
"condition": [ "ele-1" ],
"comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"base": {
"max": "1",
"min": 0,
"path": "RelatedPerson.period"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.communication",
"requirements": "If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.",
"min": 0,
"definition": "A language which may be used to communicate with about the patient's health.",
"short": "A language which may be used to communicate with about the patient's health",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "LanguageCommunication",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "*",
"id": "RelatedPerson.communication",
"condition": [ "ele-1" ],
"comment": "If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
"base": {
"max": "*",
"min": 0,
"path": "RelatedPerson.communication"
}
}, {
"path": "RelatedPerson.communication.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "RelatedPerson.communication.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "RelatedPerson.communication.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RelatedPerson.communication.extension",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "RelatedPerson.communication.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "RelatedPerson.communication.modifierExtension",
"condition": [ "ele-1" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.communication.language",
"requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min": 1,
"definition": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.",
"short": "The language which can be used to communicate with the patient about his or her health",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "RelatedPerson.communication.language",
"condition": [ "ele-1" ],
"comment": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"base": {
"max": "1",
"min": 1,
"path": "RelatedPerson.communication.language"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RelatedPerson.communication.preferred",
"requirements": "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
"min": 0,
"definition": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).",
"short": "Language preference indicator",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "preferenceInd",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "RelatedPerson.communication.preferred",
"condition": [ "ele-1" ],
"comment": "This language is specifically identified for communicating healthcare information.",
"base": {
"max": "1",
"min": 0,
"path": "RelatedPerson.communication.preferred"
}
} ]
},
"status": "draft",
"id": "912a4c3a-b095-47a6-ac6d-bbe754440d7f",
"kind": "resource",
"url": "http://koppeltaal.nl/fhir/StructureDefinition/KT2RelatedPerson",
"version": "0.11.0",
"differential": {
"element": [ {
"id": "RelatedPerson.identifier",
"min": 1,
"path": "RelatedPerson.identifier"
}, {
"id": "RelatedPerson.active",
"min": 1,
"path": "RelatedPerson.active"
}, {
"id": "RelatedPerson.patient",
"path": "RelatedPerson.patient",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://koppeltaal.nl/fhir/StructureDefinition/KT2Patient" ]
} ]
}, {
"id": "RelatedPerson.relationship",
"min": 1,
"path": "RelatedPerson.relationship"
}, {
"id": "RelatedPerson.relationship:role",
"path": "RelatedPerson.relationship",
"comment": "DO NOT use codes 23 or 24 of the code system defined in this slice to express these roles. Use the code system provided in the `customRole` slice.",
"sliceName": "role"
}, {
"id": "RelatedPerson.relationship:customRole",
"path": "RelatedPerson.relationship",
"short": "Custom role",
"binding": {
"strength": "preferred",
"valueSet": "http://vzvz.nl/fhir/ValueSet/koppeltaal-custom-roles"
},
"comment": "Use this slice ONLY to express contact person or legal guardian. DO NOT use codes 23 or 24 of the code system defined in the `role` slice to express these roles.",
"sliceName": "customRole",
"definition": "Definition of the relationship if the relation is contact person or legal guardian.",
"requirements": "This slice is included only as a emporary solution to provide missing codes. See KOP-864."
}, {
"id": "RelatedPerson.name",
"min": 1,
"path": "RelatedPerson.name"
}, {
"id": "RelatedPerson.name:nameInformation",
"path": "RelatedPerson.name",
"comment": "This `.name` element represents a Dutch name according to the [zib NameInformation (v1.1, 2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)) (except for the GivenName concept). A Dutch name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Dutch rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Dutch context **MUST** support these extensions as specified here. In addition, systems **MUST** use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. It is encouraged to provide a representation of the full name in the `.text` element.\r\n\r\n**Note 1**: The zib cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept.\r\n\r\n**Note 2**: This element should only contain a person's _official_ names. The GivenName concept is represented in another `.name` element with `.name.use` = _usual_.\r\n\r\n**Note 3**: The examples illustrate how the zib is mapped to FHIR.",
"sliceName": "nameInformation"
}, {
"id": "RelatedPerson.gender",
"min": 1,
"path": "RelatedPerson.gender"
}, {
"id": "RelatedPerson.birthDate",
"min": 1,
"path": "RelatedPerson.birthDate"
}, {
"id": "RelatedPerson.photo",
"max": "0",
"path": "RelatedPerson.photo"
} ]
},
"baseDefinition": "http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson"
}