{
"description": "Patient",
"_filename": "StructureDefinition-Patient.json",
"package_name": "hl7.fhir.nl.zorgviewer",
"date": "2024-07-26T10:52:52+00:00",
"derivation": "constraint",
"publisher": "RIVO-NN HL7NL",
"fhirVersion": "3.0.2",
"jurisdiction": [ {
"coding": [ {
"code": "NL",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "Patient",
"mapping": [ {
"uri": "https://zibs.nl/wiki/Patient-v3.1(2017EN)",
"name": "HCIM Patient-v3.1(2017EN)",
"identity": "hcim-patient-v3.1-2017EN"
}, {
"uri": "https://zibs.nl/wiki/MaritalStatus-v3.0(2017EN)",
"name": "HCIM MaritalStatus-v3.0(2017EN)",
"identity": "hcim-maritalstatus-v3.0-2017EN"
}, {
"uri": "https://zibs.nl/wiki/ContactPerson-v3.1(2017EN)",
"name": "HCIM ContactPerson-v3.1(2017EN)",
"identity": "hcim-contactperson-v3.1-2017EN"
}, {
"uri": "https://zibs.nl/wiki/HealthcareProvider-v3.1.1(2017EN)",
"name": "HCIM HealthcareProvider-v3.1.1(2017EN)",
"identity": "hcim-healthcareprovider-v3.1.1-2017EN"
}, {
"uri": "https://zibs.nl/wiki/HealthProfessional-v3.2(2017EN)",
"name": "HCIM HealthProfessional-v3.2(2017EN)",
"identity": "hcim-healthprofessional-v3.2-2017EN"
}, {
"uri": "https://zibs.nl/wiki/Nationality-v3.0(2017EN)",
"name": "HCIM Nationality-v3.0(2017EN)",
"identity": "hcim-nationality-v3.0-2017EN"
}, {
"uri": "https://zibs.nl/wiki/Payer-v3.1(2017EN)",
"name": "HCIM Payer-v3.1(2017EN)",
"identity": "hcim-payer-v3.1-2017EN"
}, {
"uri": "https://zibs.nl/wiki/ContactInformation-v1.0(2017EN)",
"name": "HCIM ContactInformation-v1.0(2017EN)",
"comment": "ContactInformation has become an independent information model as of release 2017 of the HCIMs.",
"identity": "hcim-contactinformation-v1.0-2017EN"
}, {
"uri": "https://zibs.nl/wiki/LanguageProficiency-v3.1(2017EN)",
"name": "HCIM LanguageProficiency-v3.1(2017EN)",
"identity": "hcim-languageproficiency-v3.1-2017EN"
}, {
"uri": "https://zibs.nl/wiki/FreedomRestrictingMeasures-v3.1(2017EN)",
"name": "HCIM FreedomRestrictingMeasures-v3.1(2017EN)",
"comment": "Concerns only LegalStatus concept. This will become an independent information model as of release 2018 of the HCIMs.",
"identity": "hcim-freedomrestrictingmeasures-v3.1-2017EN"
}, {
"uri": "https://zibs.nl/wiki/BasicElements-v1.0(2017EN)",
"name": "HCIM BasicElements-v1.0(2017EN)",
"identity": "hcim-basicelements-v1.0-2017EN"
}, {
"uri": "https://zibs.nl/wiki/FamilySituation-v3.0(2017EN)",
"name": "HCIM FamilySituation-v3.0(2017EN)",
"identity": "hcim-familysituation-v3.0-2017EN"
}, {
"uri": "https://zibs.nl/wiki/LifeStance-v3.1(2017EN)",
"name": "HCIM LifeStance-v3.1(2017EN)",
"identity": "hcim-lifestance-v3.1-2017EN"
}, {
"uri": "https://zibs.nl/wiki/Patient-v3.0(2016EN)",
"name": "HCIM Patient-v3.0(2016EN)",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/MaritalStatus-v3.0(2016EN)",
"name": "HCIM MaritalStatus-v3.0(2016EN)",
"identity": "hcim-maritalstatus-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/ContactPerson-v3.0(2016EN)",
"name": "HCIM ContactPerson-v3.0(2016EN)",
"identity": "hcim-contactperson-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/HealthcareProvider-v3.0(2016EN)",
"name": "HCIM HealthcareProvider-v3.0(2016EN)",
"identity": "hcim-healthcareprovider-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/HealthProfessional-v3.0(2016EN)",
"name": "HCIM HealthProfessional-v3.0(2016EN)",
"identity": "hcim-healthprofessional-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/Nationality-v3.0(2016EN)",
"name": "HCIM Nationality-v3.0(2016EN)",
"identity": "hcim-nationality-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/Payer-v3.0(2016EN)",
"name": "HCIM Payer-v3.0(2016EN)",
"identity": "hcim-payer-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/FamilySituation-v3.0(2016EN)",
"name": "HCIM FamilySituation-v3.0(2016EN)",
"identity": "hcim-familysituation-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/Patient-v2.0.1(2015EN)",
"name": "HCIM Patient-v2.0.1(2015EN)",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"uri": "https://zibs.nl/wiki/MaritalStatus-v1.2.1(2015EN)",
"name": "HCIM MaritalStatus-v1.2.1(2015EN)",
"identity": "hcim-maritalstatus-v1.2.1-2015EN"
}, {
"uri": "https://zibs.nl/wiki/ContactPerson-v1.2(2015EN)",
"name": "HCIM ContactPerson-v1.2(2015EN)",
"identity": "hcim-contactperson-v1.2-2015EN"
}, {
"uri": "https://zibs.nl/wiki/HealthcareProvider-v1.2(2015EN)",
"name": "HCIM HealthcareProvider-v1.2(2015EN)",
"identity": "hcim-healthcareprovider-v1.2-2015EN"
}, {
"uri": "https://zibs.nl/wiki/HealthProfessional-v1.2.1(2015EN)",
"name": "HCIM HealthProfessional-v1.2.1(2015EN)",
"identity": "hcim-healthprofessional-v1.2.1-2015EN"
}, {
"uri": "https://zibs.nl/wiki/Nationality-v2.0(2015EN)",
"name": "HCIM Nationality-v2.0(2015EN)",
"identity": "hcim-nationality-v2.0-2015EN"
}, {
"uri": "https://zibs.nl/wiki/Payer-v1.2(2015EN)",
"name": "HCIM Payer-v1.2(2015EN)",
"identity": "hcim-payer-v1.2-2015EN"
}, {
"uri": "https://zibs.nl/wiki/FamilySituation-v1.0(2015EN)",
"name": "HCIM FamilySituation-v1.0(2015EN)",
"identity": "hcim-familysituation-v1.0-2015EN"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)",
"identity": "cda"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://loinc.org",
"name": "LOINC code for the element",
"identity": "loinc"
} ],
"abstract": false,
"type": "Patient",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Patient",
"package_version": "1.2.0",
"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-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.text.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",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "Patient",
"min": 0,
"definition": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.",
"short": "Patient",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Patient[classCode=PAT]",
"identity": "rim"
}, {
"map": "ClinicalDocument.recordTarget.patientRole",
"identity": "cda"
}, {
"map": "administrative.individual",
"identity": "w5"
}, {
"map": "NL-CM:0.1.1",
"comment": "Patient",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.1",
"comment": "Patient",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.1",
"comment": "Patient",
"identity": "hcim-patient-v3.1-2017EN"
}, {
"map": "NL-CM:1.1.2",
"comment": "PayerPerson",
"identity": "hcim-payer-v1.2-2015EN"
}, {
"map": "NL-CM:1.1.2",
"comment": "PayerPerson",
"identity": "hcim-payer-v3.0-2016EN"
}, {
"map": "NL-CM:1.1.2",
"comment": "PayerPerson",
"identity": "hcim-payer-v3.1-2017EN"
}, {
"map": "NL-CM:0.0.3",
"comment": "PatientAsInformationSource::Patient",
"identity": "hcim-basicelements-v1.0-2017EN"
}, {
"map": "NL-CM:0.0.8",
"comment": "PatientAsAuthor::Patient",
"identity": "hcim-basicelements-v1.0-2017EN"
}, {
"map": "NL-CM:0.0.12",
"comment": "Patient",
"identity": "hcim-basicelements-v1.0-2017EN"
} ],
"alias": [ "SubjectOfCare Client Resident", "Patiënt" ],
"max": "*",
"id": "Patient",
"base": {
"max": "*",
"min": 0,
"path": "Patient"
}
}, {
"path": "Patient.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": "id"
} ],
"max": "1",
"id": "Patient.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
}, {
"path": "Patient.meta",
"min": 0,
"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",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Patient.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Patient.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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Patient.implicitRules",
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Patient.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Patient.language",
"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"
}
}, {
"path": "Patient.text",
"min": 0,
"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",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Patient.text",
"condition": [ "dom-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 in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Patient.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": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Patient.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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Patient.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.extension",
"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() | (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": "Patient.extension",
"min": 0,
"definition": "Optional Extension Element - found in all resources.",
"short": "References a patient's preferered pharmacy",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy"
} ],
"sliceName": "preferredPharmacy",
"alias": [ "Verwijst naar de voorkeursapotheek van de patiënt" ],
"max": "1",
"id": "Patient.extension:preferredPharmacy",
"condition": [ "ele-1" ],
"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() | (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": "Patient.extension",
"min": 0,
"definition": "The nationality of the patient.",
"short": "Nationality",
"mapping": [ {
"map": "NL-CM:7.6.3",
"comment": "Nationality",
"identity": "hcim-nationality-v2.0-2015EN"
}, {
"map": "NL-CM:7.6.3",
"comment": "Nationality",
"identity": "hcim-nationality-v3.0-2016EN"
}, {
"map": "NL-CM:7.6.3",
"comment": "Nationality",
"identity": "hcim-nationality-v3.0-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/patient-nationality"
} ],
"sliceName": "nationality",
"alias": [ "Nationaliteit" ],
"max": "*",
"id": "Patient.extension:nationality",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Patient.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:nationality.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.extension:nationality.extension",
"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"
}
}, {
"path": "Patient.extension.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"type": [ {
"code": "Extension"
} ],
"sliceName": "code",
"max": "1",
"id": "Patient.extension:nationality.extension:code",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.extension.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:nationality.extension:code.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.extension.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.extension:nationality.extension:code.extension",
"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"
}
}, {
"path": "Patient.extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "code",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:nationality.extension:code.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.extension.extension.valueCodeableConcept",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "valueCodeableConcept",
"binding": {
"strength": "extensible",
"description": "Indicates the country of citizenship.",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20171231000000"
}
},
"max": "1",
"id": "Patient.extension:nationality.extension:code.valueCodeableConcept:valueCodeableConcept",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.extension.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"type": [ {
"code": "Extension"
} ],
"sliceName": "period",
"max": "1",
"id": "Patient.extension:nationality.extension:period",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.extension.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:nationality.extension:period.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.extension.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.extension:nationality.extension:period.extension",
"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"
}
}, {
"path": "Patient.extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "period",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:nationality.extension:period.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.extension.extension.valuePeriod",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"sliceName": "valuePeriod",
"max": "1",
"id": "Patient.extension:nationality.extension:period.valuePeriod:valuePeriod",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-nationality",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:nationality.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.extension.value[x]",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "0",
"id": "Patient.extension:nationality.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"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() | (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": "Patient.extension",
"min": 0,
"definition": "The legal situation that applies to the patient during the intervention. The code of the legal status is based on the Vektis/AZR code list COD232-VEKT Legal Status.",
"short": "legalStatus",
"mapping": [ {
"map": "NL-CM:14.3.2",
"comment": "LegalStatus",
"identity": "hcim-freedomrestrictingmeasures-v3.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus"
} ],
"sliceName": "legalStatus",
"max": "2",
"id": "Patient.extension:legalStatus",
"condition": [ "ele-1" ],
"comment": "The concept LegalStatus of the HCIM FreedomRestrictingMeasures plays an important role in the context of mental healthcare (GGZ). This concept will become an independent HCIM with the next release of HCIM (2018 release). \r\n\r\nThe LegalStatus concept and associated ValueSet will be split in two concepts: legal status and representative. These concepts are currently captured in one ValueSet. It is possible to have a legal status AND a representative. Therefore, we allow this extension to have a cardinality of 0..2.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Patient.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:legalStatus.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.extension:legalStatus.extension",
"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"
}
}, {
"path": "Patient.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:legalStatus.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.extension.value[x]",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "closed",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"type": [ {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "Patient.extension:legalStatus.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.extension.value[x]",
"min": 1,
"definition": "The legal situation that applies to the patient during the intervention. The code of the legal status is based on the Vektis/AZR code list COD232-VEKT Legal Status.",
"short": "LegalStatus",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "valueCodeableConcept",
"binding": {
"strength": "extensible",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.3.2--20171231000000"
}
},
"alias": [ "JuridischeStatus" ],
"max": "1",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.extension.value[x].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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.extension.value[x].extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.extension",
"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"
}
}, {
"path": "Patient.extension.value[x].coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].coding.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.extension.value[x].coding.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.coding.extension",
"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"
}
}, {
"path": "Patient.extension.value[x].coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.coding.system",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.coding.version",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.coding.userSelected",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Patient.extension:legalStatus.value[x]:valueCodeableConcept.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"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() | (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": "Patient.extension",
"min": 0,
"definition": "Optional Extension Element - found in all resources.",
"short": "Optional Extensions Element",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
} ],
"sliceName": "lifeStance",
"max": "*",
"id": "Patient.extension:lifeStance",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Patient.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:lifeStance.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.extension:lifeStance.extension",
"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"
}
}, {
"path": "Patient.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:lifeStance.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.extension.value[x]",
"min": 1,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "closed",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"type": [ {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.extension.value[x]",
"min": 1,
"definition": "Patient’s life stance and/or religion.",
"short": "LifeStance",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "NL-CM:7.5.2",
"comment": "LifeStance",
"identity": "hcim-lifestance-v3.1-2017EN"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "valueCodeableConcept",
"binding": {
"strength": "preferred",
"description": "LevensovertuigingCodelijst",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.5.1--20171231000000"
}
},
"alias": [ "Levensovertuiging" ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.extension.value[x].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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.extension.value[x].extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.extension",
"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"
}
}, {
"path": "Patient.extension.value[x].coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].coding.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.extension.value[x].coding.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.coding.extension",
"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"
}
}, {
"path": "Patient.extension.value[x].coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.coding.system",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.coding.version",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.coding.userSelected",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Patient.extension.value[x].text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Patient.extension:lifeStance.value[x]:valueCodeableConcept.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Patient.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. 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.modifierExtension",
"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"
}
}, {
"path": "Patient.identifier",
"requirements": "Patients are almost always assigned specific numerical identifiers.",
"min": 1,
"definition": "The Burgerservicenummer or BSN, as one of the possible patient identification numbers, should at least be sent unless there is a reason not to. Reasons for not sending the burgerservicenummer include but are not limited to, research and apps without a contract for processing data (Dutch: bewerkingsovereenkomst).",
"short": "PatientIdentificationNumber",
"mapping": [ {
"map": "PID-3",
"identity": "v2"
}, {
"map": "id",
"identity": "rim"
}, {
"map": ".id",
"identity": "cda"
}, {
"map": "id",
"identity": "w5"
}, {
"map": "NL-CM:0.1.7",
"comment": "PatientIdentificationNumber",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.7",
"comment": "PatientIdentificationNumber",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.7",
"comment": "PatientIdentificationNumber",
"identity": "hcim-patient-v3.1-2017EN"
}, {
"map": "NL-CM:0.0.6",
"comment": "IdentificationNumber",
"identity": "hcim-basicelements-v1.0-2017EN"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"type": [ {
"code": "Identifier"
} ],
"alias": [ "Identificatienummer" ],
"max": "*",
"id": "Patient.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Patient.identifier"
},
"isSummary": true
}, {
"path": "Patient.identifier",
"requirements": "Patients are almost always assigned specific numerical identifiers.",
"min": 1,
"definition": "An identifier for this patient.",
"short": "BSN",
"mapping": [ {
"map": "PID-3",
"identity": "v2"
}, {
"map": "id",
"identity": "rim"
}, {
"map": ".id",
"identity": "cda"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"sliceName": "BSN",
"alias": [ "BSN" ],
"max": "1",
"id": "Patient.identifier:BSN",
"base": {
"max": "*",
"min": 0,
"path": "Patient.identifier"
},
"isSummary": true
}, {
"path": "Patient.identifier.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.identifier:BSN.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.identifier.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.identifier:BSN.extension",
"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"
}
}, {
"path": "Patient.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"max": "1",
"id": "Patient.identifier:BSN.use",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isSummary": true
}, {
"path": "Patient.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"short": "Description of identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
"max": "1",
"id": "Patient.identifier:BSN.type",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"path": "Patient.identifier.system",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"short": "The namespace for the identifier value",
"fixedUri": "http://fhir.nl/fhir/NamingSystem/bsn",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Patient.identifier:BSN.system",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"path": "Patient.identifier.value",
"min": 1,
"definition": "Burgerservicenummer is the Dutch person identification number which is also allowed for use in healthcare.",
"short": "BSN (Burgerservicenummer (Dutch person identification number))",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "BSN" ],
"max": "1",
"id": "Patient.identifier:BSN.value",
"comment": "The official format according to the 'Logisch Ontwerp BSN 1.4.pdf' is N8..9 and SHALL conform to an 11-proof algorithm. In order to check if the number is 11-proof the number, if N8, SHALL be prefixed with a leading zero. The expected format in FHIR is N9 with leading zero applied to any N8 bsn.",
"example": [ {
"label": "General",
"valueString": "123456"
}, {
"label": "Example of a burgerservicenummer",
"valueString": "123456782"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"path": "Patient.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.identifier:BSN.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"path": "Patient.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Patient.identifier:BSN.assigner",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"path": "Patient.active",
"requirements": "Need to be able to mark a patient record as not to be used because it was created in error.",
"min": 0,
"definition": "This field determines the status of the 'patient' record in the context of the organization that owns the record. Note that the record is not the medical record, but rather the actual patient 'resource'. Obviously when the patient 'resource' is not active, then by extension his medical record might also be inactive. Patient.active='false' may be used discourage use of the record, but that it is kept beause there is (medical) data attached to it. Another use case is a patient moving to a different GP practice. Patient.active would be 'false' in the system of the previous GP.",
"isModifier": true,
"short": "Whether this patient's record is in active use",
"mapping": [ {
"map": "statusCode",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": true,
"max": "1",
"id": "Patient.active",
"comment": "Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient\n\nThis element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.active"
},
"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() | (children().count() > id.count())"
}, {
"key": "nl-core-humanname-1",
"human": "if you specify a prefix for an own name then an own name is also expected",
"xpath": "not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-name']",
"source": "http://hl7.org/fhir/StructureDefinition/Patient",
"severity": "error",
"expression": "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()"
}, {
"key": "nl-core-humanname-2",
"human": "if you specify a voorvoegsel for a partner name then a partner name is also expected",
"xpath": "not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-name']",
"source": "http://hl7.org/fhir/StructureDefinition/Patient",
"severity": "error",
"expression": "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()"
}, {
"key": "zv-pat-1",
"human": "Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present.",
"xpath": "/f:name/f:family or /f:name/f:given or /f:name/f:text",
"severity": "error",
"expression": "(family.exists() or given.exists() or text.exists())"
}, {
"key": "zv-pat-2",
"human": "To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.",
"xpath": "/f:name/f:text",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
} ],
"expression": "text.exists()"
} ],
"path": "Patient.name",
"requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.",
"min": 1,
"definition": "A human's name with the ability to identify parts and usage.",
"short": "NameInformation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN",
"identity": "v2"
}, {
"map": "EN (actually, PN)",
"identity": "rim"
}, {
"map": "ProviderName",
"identity": "servd"
}, {
"map": "NL-CM:0.1.6",
"comment": "NameInformation",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.6",
"comment": "NameInformation",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.1",
"comment": "NameInformation",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
}, {
"map": "02",
"comment": "Naam",
"identity": "BRP"
}, {
"map": "NL-CM:0.1.6",
"comment": "NameInformation",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.6",
"comment": "NameInformation",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.6",
"comment": "NameInformation",
"identity": "hcim-patient-v3.1-2017EN"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v1.2-2015EN"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v3.0-2016EN"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v3.1-2017EN"
} ],
"type": [ {
"code": "HumanName",
"profile": "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname"
} ],
"mustSupport": true,
"alias": [ "Naamgegevens" ],
"max": "*",
"id": "Patient.name",
"condition": [ "ele-1" ],
"comment": "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.\r\n\r\nThe 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.\r\n\r\n**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. \r\n\r\nThe 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 `.use` element. However, this specification allows for including all alternative representations in the _same_ HumanName instance, with the expectation that the extensions provide enough information for receiving systems to differentiate them. However, this means that contrary to the normal usage of this datatype, repetitions of `.given` names cannot be concatenated to get the full list of given names; the list might be a mix of full names, nicknames and initials.\r\n\r\nSince multiple implementations are based on this specification, sending systems are advised (but not required) to keep the approach with one HumanName instance, while receiving systems should be able to handle this one-instance approach. More specifically:\r\n\r\n* Sending and receiving systems SHOULD always use the specified extensions when using this datatype.\r\n* Sending systems are encouraged to populate the `.text` element to unambigiously communicate the person's name.\r\n* Sending systems are encouraged to send either the full given names or the initials, but not both. This alleviates the duplication of names in `.given`.\r\n* When a sending system uses the current one-instance approach for communicating multiple representations, `.use` MAY NOT be populated. After all, it is not possible to select a single `.use` when the instance contains different representations.\r\n* When a receiving system interprets the instance as the single-instance-multiple-representations approach, the `.given` names marked as initials SHOULD be interpreted as alternatives to the full given names. Note the underlying HCIM expects both the _list_ of full names and _list_ of initials to be a single string; there's no match for an initial to a full name. The instance SHOULD be regarded as using this approach when:\r\n * They encounter a single instance\r\n * And the `.use` element is absent\r\n * And all the name parts are differentiated using the specified extensions\r\n* In any other circumstance, receiving systems SHOULD interpret the usage as the normal use.\r\n\r\nExample: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas:\r\n\r\n* `.family` = \"Jongeneel-de Haas\"\r\n* `.given` = \"Irma\" (with `.given:iso21090EnQualifier` = _BR_)\r\n* `.family:humannameOwnName` = \"Jongeneel\"\r\n* `.family:humannamePartnerPrefix` = \"de \"\r\n* `.family:humannamePartnerName` = \"Haas\"",
"example": [ {
"label": "Structured HumanName (preferred above unstructured)",
"valueHumanName": {
"text": "Irma Jongeneel-de Haas",
"given": [ "Irma" ],
"_given": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCode": "CL"
} ]
} ],
"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"
} ]
},
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
"valueCode": "NL4"
} ]
}
}, {
"label": "Unstructured HumanName",
"valueHumanName": {
"text": "Irma Jongeneel-de Haas"
}
} ],
"base": {
"max": "*",
"min": 0,
"path": "Patient.name"
}
}, {
"path": "Patient.name.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.name.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.name.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.name.extension",
"min": 0,
"definition": "A code that represents the preferred display order of the components of this human name.",
"short": "Preferred display order of name parts",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
} ],
"sliceName": "humannameAssemblyOrder",
"max": "*",
"id": "Patient.name.extension:humannameAssemblyOrder",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.name.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.extension:humannameAssemblyOrder.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.name.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.name.extension:humannameAssemblyOrder.extension",
"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"
}
}, {
"path": "Patient.name.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.extension:humannameAssemblyOrder.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.name.extension.valueCode",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"sliceName": "valueCode",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "HumanNameAssemblyOrder"
} ],
"description": "A code that represents the preferred display order of the components of a human name",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-assembly-order"
}
},
"max": "1",
"id": "Patient.name.extension:humannameAssemblyOrder.valueCode:valueCode",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.name.use",
"requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min": 0,
"definition": "Identifies the purpose for this name.",
"isModifier": true,
"short": "usual | official | temp | nickname | anonymous | old | maiden",
"mapping": [ {
"map": "XPN.7, but often indicated by which field contains the name",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./NamePurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NameUse"
} ],
"description": "The use of a human name",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-use"
}
},
"max": "1",
"id": "Patient.name.use",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.use"
},
"isSummary": true
}, {
"path": "Patient.name.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "A full text representation of the name.",
"short": "Text representation of the full name",
"mapping": [ {
"map": "implied by XPN.11",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v1.2-2015EN"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v3.0-2016EN"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v3.1-2017EN"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.name.text",
"comment": "Can provide both a text representation and structured parts.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.text"
},
"isSummary": true
}, {
"path": "Patient.name.family",
"min": 0,
"definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
"short": "Surname",
"mapping": [ {
"map": "XPN.1/FN.1",
"identity": "v2"
}, {
"map": "./part[partType = FAM]",
"identity": "rim"
}, {
"map": "./FamilyName",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "surname", "Achternaam" ],
"max": "1",
"id": "Patient.name.family",
"comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.family"
},
"isSummary": true
}, {
"path": "Patient.name.family.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.family.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.name.family.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.name.family.extension",
"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() | (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": "Patient.name.family.extension",
"min": 0,
"definition": "The prefix portion (e.g. voorvoegsel) inclusive of the space between the prefix and the surname, if applicable, of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.",
"short": "PrefixOwnName",
"mapping": [ {
"map": "FN.2",
"identity": "v2"
}, {
"map": "ENXP where Qualifiers = (VV, R)",
"identity": "rim"
}, {
"map": "NL-CM:0.1.38",
"comment": "Prefix",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.38",
"comment": "Prefix",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.11",
"comment": "Prefix",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
} ],
"sliceName": "humannameOwnPrefix",
"alias": [ "VoorvoegselGeslachtsnaam" ],
"max": "1",
"id": "Patient.name.family.extension:humannameOwnPrefix",
"condition": [ "ele-1" ],
"comment": "An example of a voorvoegsel is the \"van\" in \"Ludwig van Beethoven\". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.name.family.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.family.extension:humannameOwnPrefix.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.name.family.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.name.family.extension:humannameOwnPrefix.extension",
"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"
}
}, {
"path": "Patient.name.family.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.family.extension:humannameOwnPrefix.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.name.family.extension.valueString",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"sliceName": "valueString",
"max": "1",
"id": "Patient.name.family.extension:humannameOwnPrefix.valueString:valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"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() | (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": "Patient.name.family.extension",
"min": 0,
"definition": "The person’s official last name.",
"short": "OwnName",
"mapping": [ {
"map": "FN.3",
"identity": "v2"
}, {
"map": "ENXP where Qualifiers = (BR)",
"identity": "rim"
}, {
"map": "NL-CM:0.1.24",
"comment": "LastName",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.24",
"comment": "LastName",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.10",
"comment": "LastName",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
} ],
"sliceName": "humannameOwnName",
"alias": [ "Geslachtsnaam" ],
"max": "1",
"id": "Patient.name.family.extension:humannameOwnName",
"condition": [ "ele-1" ],
"comment": "The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's \"maiden name\".",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.name.family.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.family.extension:humannameOwnName.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.name.family.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.name.family.extension:humannameOwnName.extension",
"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"
}
}, {
"path": "Patient.name.family.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.family.extension:humannameOwnName.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.name.family.extension.valueString",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"sliceName": "valueString",
"max": "1",
"id": "Patient.name.family.extension:humannameOwnName.valueString:valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"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() | (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": "Patient.name.family.extension",
"min": 0,
"definition": "Voorvoegsel derived from person's partner's surname inclusive of the space between the prefix and the surname, if applicable.",
"short": "PrefixSurname",
"mapping": [ {
"map": "FN.4",
"identity": "v2"
}, {
"map": "ENXP where Qualifiers = (VV, SP)",
"identity": "rim"
}, {
"map": "NL-CM:0.1.39",
"comment": "PartnerPrefix",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.39",
"comment": "PartnerPrefix",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.9",
"comment": "PartnerPrefix",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
} ],
"sliceName": "humannamePartnerPrefix",
"alias": [ "VoorvoegselGeslachtsnaamPartner" ],
"max": "1",
"id": "Patient.name.family.extension:humannamePartnerPrefix",
"condition": [ "ele-1" ],
"comment": "An example of a voorvoegsel is the \"van\" in \"Ludwig van Beethoven\". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.name.family.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.family.extension:humannamePartnerPrefix.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.name.family.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.name.family.extension:humannamePartnerPrefix.extension",
"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"
}
}, {
"path": "Patient.name.family.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.family.extension:humannamePartnerPrefix.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.name.family.extension.valueString",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"sliceName": "valueString",
"max": "1",
"id": "Patient.name.family.extension:humannamePartnerPrefix.valueString:valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"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() | (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": "Patient.name.family.extension",
"min": 0,
"definition": "Partner’s official last name.",
"short": "LastNamePartner",
"mapping": [ {
"map": "FN.5",
"identity": "v2"
}, {
"map": "ENXP where Qualifiers = (SP)",
"identity": "rim"
}, {
"map": "NL-CM:0.1.25",
"comment": "PartnerLastName",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.25",
"comment": "PartnerLastName",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.8",
"comment": "PartnerLastName",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
} ],
"sliceName": "humannamePartnerName",
"alias": [ "GeslachtsnaamPartner" ],
"max": "1",
"id": "Patient.name.family.extension:humannamePartnerName",
"condition": [ "ele-1" ],
"comment": "The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's \"maiden name\".",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.name.family.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.family.extension:humannamePartnerName.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.name.family.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.name.family.extension:humannamePartnerName.extension",
"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"
}
}, {
"path": "Patient.name.family.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.family.extension:humannamePartnerName.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.name.family.extension.valueString",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"sliceName": "valueString",
"max": "1",
"id": "Patient.name.family.extension:humannamePartnerName.valueString:valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.name.family.value",
"min": 0,
"definition": "The actual value",
"short": "Primitive value for string",
"type": [ {
"_code": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:string"
} ]
}
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.family.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
}
}, {
"path": "Patient.name.given",
"min": 0,
"definition": "Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot.",
"short": "Given",
"mapping": [ {
"map": "XPN.2 + XPN.3",
"identity": "v2"
}, {
"map": "./part[partType = GIV]",
"identity": "rim"
}, {
"map": "./GivenNames",
"identity": "servd"
}, {
"map": "NL-CM:0.1.26",
"comment": "FirstNames. Qualifier 'BR'",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.35",
"comment": "Initials. Qualifier 'IN'",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.27",
"comment": "GivenName. Qualifier 'CL'",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "02.10",
"comment": "Voornamen",
"identity": "BRP"
}, {
"map": "NL-CM:0.1.26",
"comment": "FirstNames. Qualifier 'BR'",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.35",
"comment": "Initials. Qualifier 'IN'",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.27",
"comment": "GivenName. Qualifier 'CL'",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.4",
"comment": "FirstNames. Qualifier 'BR'",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
}, {
"map": "NL-CM:20.4.5",
"comment": "Initials. Qualifier 'IN'",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
}, {
"map": "NL-CM:20.4.6",
"comment": "GivenName. Qualifier 'CL'",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "first name", "middle name", "Voornamen", "Initialen", "Roepnaam" ],
"max": "*",
"id": "Patient.name.given",
"comment": "Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. To be conformant to the HCIM for NameInformation, at least the following qualifiers SHALL be supported: _BR_, _IN_ and _CL_. The qualifier _BR_ maps to the HCIM concept FirstNames, _IN_ maps to Initials and _CL_ to GivenName.\r\n\r\nPlease see the compatibility note on the containing element as well!",
"orderMeaning": "Given Names appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.given"
},
"isSummary": true
}, {
"path": "Patient.name.given.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.given.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.name.given.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.name.given.extension",
"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() | (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": "Patient.name.given.extension",
"min": 0,
"definition": "A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.",
"isModifier": false,
"short": "LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV",
"mapping": [ {
"map": "ENXP.qualifier",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
} ],
"sliceName": "iso21090EnQualifier",
"max": "1",
"id": "Patient.name.given.extension:iso21090EnQualifier",
"condition": [ "ele-1" ],
"comment": "Used to indicate additional information about the name part and how it should be used.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.name.given.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.given.extension:iso21090EnQualifier.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.name.given.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.name.given.extension:iso21090EnQualifier.extension",
"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"
}
}, {
"path": "Patient.name.given.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.given.extension:iso21090EnQualifier.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.name.given.extension.valueCode",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"sliceName": "valueCode",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EntityNamePartQualifier"
} ],
"description": "A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-part-qualifier"
}
},
"max": "1",
"id": "Patient.name.given.extension:iso21090EnQualifier.valueCode:valueCode",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.name.given.value",
"min": 0,
"definition": "The actual value",
"short": "Primitive value for string",
"type": [ {
"_code": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:string"
} ]
}
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.given.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
}
}, {
"path": "Patient.name.prefix",
"min": 0,
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
"short": "Parts that come before the name",
"mapping": [ {
"map": "XPN.5",
"identity": "v2"
}, {
"map": "./part[partType = PFX]",
"identity": "rim"
}, {
"map": "./TitleCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Patient.name.prefix",
"orderMeaning": "Prefixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.prefix"
},
"isSummary": true
}, {
"path": "Patient.name.suffix",
"min": 0,
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
"short": "Parts that come after the name",
"mapping": [ {
"map": "XPN/4",
"identity": "v2"
}, {
"map": "./part[partType = SFX]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Patient.name.suffix",
"orderMeaning": "Suffixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.suffix"
},
"isSummary": true
}, {
"path": "Patient.name.period",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"definition": "Indicates the period of time when this name was valid for the named person.",
"short": "Time period when name was/is in use",
"mapping": [ {
"map": "XPN.13 + XPN.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.name.period",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.period"
},
"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() | (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": "Patient.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "A contact detail for the individual. Note that there is no support for multiple use values like 'mobile business'.",
"short": "ContactInformation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XTN",
"identity": "v2"
}, {
"map": "TEL",
"identity": "rim"
}, {
"map": "ContactPoint",
"identity": "servd"
}, {
"map": "NL-CM:0.1.5",
"comment": "ContactInformation",
"identity": "hcim-contactinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.5",
"comment": "ContactInformation",
"identity": "hcim-contactinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.6.1",
"comment": "ContactInformation",
"identity": "hcim-contactinformation-v1.0-2017EN"
}, {
"map": "NL-CM:0.1.5",
"comment": "ContactInformation",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.5",
"comment": "ContactInformation",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.5",
"comment": "ContactInformation",
"identity": "hcim-patient-v3.1-2017EN"
}, {
"map": "NL-CM:1.1.12",
"comment": "TelephoneEmail::ContactInformation",
"identity": "hcim-payer-v1.2-2015EN"
}, {
"map": "NL-CM:1.1.12",
"comment": "TelephoneEmail::ContactInformation",
"identity": "hcim-payer-v3.0-2016EN"
}, {
"map": "NL-CM:1.1.12",
"comment": "ContactInformation",
"identity": "hcim-payer-v3.1-2017EN"
} ],
"type": [ {
"code": "ContactPoint",
"profile": "http://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint"
} ],
"alias": [ "Contactgegevens" ],
"max": "*",
"id": "Patient.telecom",
"condition": [ "ele-1" ],
"comment": "A Patient 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. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
"example": [ {
"label": "Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.",
"valueContactPoint": {
"use": "work",
"value": "+31611234567",
"system": "phone"
}
}, {
"label": "Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.",
"valueContactPoint": {
"use": "mobile",
"value": "+31611234567",
"system": "phone"
}
}, {
"label": "Primary Home Land Line",
"valueContactPoint": {
"use": "home",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "LL",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Land Line"
} ]
}
} ]
}
}, {
"label": "Temporary Land Line",
"valueContactPoint": {
"use": "temp",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "LL",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Land Line"
} ]
}
} ]
}
}, {
"label": "Primary Work Land Line",
"valueContactPoint": {
"use": "work",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "LL",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Land Line"
} ]
}
} ]
}
}, {
"label": "Primary Home Fax",
"valueContactPoint": {
"use": "home",
"value": "...",
"system": "fax",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "FAX",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Fax"
} ]
}
} ]
}
}, {
"label": "Temporary Fax",
"valueContactPoint": {
"use": "temp",
"value": "...",
"system": "fax",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "FAX",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Fax"
} ]
}
} ]
}
}, {
"label": "Primary Work Fax",
"valueContactPoint": {
"use": "work",
"value": "...",
"system": "fax",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "FAX",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Fax"
} ]
}
} ]
}
}, {
"label": "Primary Home Mobile Phone",
"valueContactPoint": {
"use": "home",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "MC",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Mobile Phone"
} ]
}
} ]
}
}, {
"label": "Temporary Mobile Phone",
"valueContactPoint": {
"use": "temp",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "MC",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Mobile Phone"
} ]
}
} ]
}
}, {
"label": "Primary Work Mobile Phone",
"valueContactPoint": {
"use": "work",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "MC",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Mobile Phone"
} ]
}
} ]
}
}, {
"label": "Primary Home Pager",
"valueContactPoint": {
"use": "home",
"value": "...",
"system": "pager",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "PG",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Pager"
} ]
}
} ]
}
}, {
"label": "Temporary Pager",
"valueContactPoint": {
"use": "temp",
"value": "...",
"system": "pager",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "PG",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Pager"
} ]
}
} ]
}
}, {
"label": "Primary Work Pager",
"valueContactPoint": {
"use": "work",
"value": "...",
"system": "pager",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "PG",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Pager"
} ]
}
} ]
}
}, {
"label": "Private email address",
"valueContactPoint": {
"use": "home",
"value": "giesput@myweb.nl",
"system": "email"
}
}, {
"label": "Work email address",
"valueContactPoint": {
"use": "work",
"value": "example@workplace.nl",
"system": "email"
}
} ],
"base": {
"max": "*",
"min": 0,
"path": "Patient.telecom"
}
}, {
"path": "Patient.gender",
"requirements": "Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.",
"min": 0,
"definition": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.",
"short": "Gender",
"mapping": [ {
"map": "PID-8",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender",
"identity": "rim"
}, {
"map": ".patient.administrativeGenderCode",
"identity": "cda"
}, {
"map": "NL-CM:0.1.9",
"comment": "Gender. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.9",
"comment": "Gender. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.9",
"comment": "Gender. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender",
"identity": "hcim-patient-v3.1-2017EN"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"alias": [ "Geslacht" ],
"max": "1",
"id": "Patient.gender",
"comment": "The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a \"hard\" error.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.gender"
},
"isSummary": true
}, {
"path": "Patient.gender.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.gender.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.gender.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.gender.extension",
"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() | (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": "Patient.gender.extension",
"min": 0,
"definition": "Patient’s administrative gender.",
"short": "Gender",
"type": [ {
"code": "Extension",
"profile": "http://nictiz.nl/fhir/StructureDefinition/code-specification"
} ],
"sliceName": "GeslachtCodelijst",
"alias": [ "Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet.", "Geslacht" ],
"max": "1",
"id": "Patient.gender.extension:GeslachtCodelijst",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.gender.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.gender.extension:GeslachtCodelijst.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.gender.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.gender.extension:GeslachtCodelijst.extension",
"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"
}
}, {
"path": "Patient.gender.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://nictiz.nl/fhir/StructureDefinition/code-specification",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.gender.extension:GeslachtCodelijst.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.gender.extension.value[x]",
"min": 1,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "closed",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"type": [ {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "Patient.gender.extension:GeslachtCodelijst.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.gender.extension.value[x]",
"min": 1,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "valueCodeableConcept",
"binding": {
"strength": "extensible",
"description": "GeslachtCodelijst",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20171231000000"
}
},
"max": "1",
"id": "Patient.gender.extension:GeslachtCodelijst.value[x]:valueCodeableConcept",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.gender.value",
"min": 0,
"definition": "Primitive value for code",
"short": "Primitive value for code",
"type": [ {
"_code": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:token"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:token"
} ]
},
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex",
"valueString": "[^\\s]+([\\s]?[^\\s]+)*"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.gender.value",
"base": {
"max": "1",
"min": 0,
"path": "string.value"
}
}, {
"path": "Patient.birthDate",
"requirements": "Age of the individual drives many clinical processes.",
"min": 0,
"definition": "The date of birth for the individual.",
"short": "Patients date of birth. The date of birth is mandatory for a patient. An incomplete date, e.g. only year or only year + month, is permitted.",
"mapping": [ {
"map": "PID-7",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime",
"identity": "rim"
}, {
"map": ".patient.birthTime",
"identity": "cda"
}, {
"map": "21112-8",
"identity": "loinc"
}, {
"map": "NL-CM:0.1.10",
"comment": "DateOfBirth",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.10",
"comment": "DateOfBirth",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.10",
"comment": "DateOfBirth",
"identity": "hcim-patient-v3.1-2017EN"
} ],
"type": [ {
"code": "date"
} ],
"mustSupport": true,
"alias": [ "Geboortedatum" ],
"max": "1",
"id": "Patient.birthDate",
"comment": "At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension \"patient-birthTime\" available that should be used where Time is required (such as in maternaty/infant care systems).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.birthDate"
},
"isSummary": true
}, {
"path": "Patient.deceased[x]",
"requirements": "The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.",
"min": 0,
"definition": "Indicates if the individual is deceased or not.",
"isModifier": true,
"short": "DeathIndicator/DateOfDeath",
"mapping": [ {
"map": "PID-30 (bool) and PID-29 (datetime)",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "NL-CM:0.1.32",
"comment": "DeathIndicator",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.32",
"comment": "DeathIndicator",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.32",
"comment": "DeathIndicator",
"identity": "hcim-patient-v3.1-2017EN"
}, {
"map": "NL-CM:0.1.33",
"comment": "DateOfDeath",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.33",
"comment": "DateOfDeath",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.33",
"comment": "DateOfDeath",
"identity": "hcim-patient-v3.1-2017EN"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "dateTime"
} ],
"mustSupport": true,
"alias": [ "Overlijdensindicator/DatumOverlijden" ],
"max": "1",
"id": "Patient.deceased[x]",
"comment": "If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.\n\nThis element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.deceased[x]"
},
"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() | (children().count() > id.count())"
}, {
"key": "nl-streetname-if-official-and-other-line-parts",
"human": "Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value",
"xpath": "not(.[f:extension[@url='http://fhir.nl/fhir/StructureDefinition/nl-core-address-official'][f:valueBoolean/@value='true']][f:line[empty(f:extension[@url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName'])][f:extension[@url=('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator')]]])",
"source": "http://hl7.org/fhir/StructureDefinition/Patient",
"severity": "error",
"expression": "(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()))",
"requirements": "This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address"
} ],
"path": "Patient.address",
"requirements": "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.",
"min": 0,
"definition": "This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the HCIM AddressInformation (v1.0, 2017). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype.\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 HCIM defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the HCIM concepts are mapped to the various FHIR elements (see the ConceptMaps and as well). The HCIM code itself should also be included using the AddressType extension.\r\n\r\n| HCIM |` .ext:AddressType` | `.ext:official` | `.use` | `.type` |\r\n|-----------------------------------|:------------------:|:---------------:|:------:|:----------:|\r\n| Postal Address/Postadres | _PST_ | | | _postal_ |\r\n| Primary Home/Officieel adres | _HP_ | true | _home_ | |\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\n 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.\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 HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension.",
"short": "AddressInformation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD",
"identity": "v2"
}, {
"map": "AD",
"identity": "rim"
}, {
"map": "Address",
"identity": "servd"
}, {
"map": "NL-CM:0.1.4",
"comment": "AddressInformation",
"identity": "hcim-address-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.4",
"comment": "AddressInformation",
"identity": "hcim-addressinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.5.1",
"comment": "AddressInformation",
"identity": "hcim-addressinformation-v1.0-2017EN"
}, {
"map": "NL-CM:0.1.4",
"comment": "AddressInformation",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.4",
"comment": "AddressInformation",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.4",
"comment": "AddressInformation",
"identity": "hcim-patient-v3.1-2017EN"
}, {
"map": "NL-CM:1.1.17",
"comment": "AddressInformation",
"identity": "hcim-payer-v1.2-2015EN"
}, {
"map": "NL-CM:1.1.17",
"comment": "Address",
"identity": "hcim-payer-v3.0-2016EN"
}, {
"map": "NL-CM:1.1.17",
"comment": "AddressInformation",
"identity": "hcim-payer-v3.1-2017EN"
} ],
"type": [ {
"code": "Address",
"profile": "http://fhir.nl/fhir/StructureDefinition/nl-core-address"
} ],
"alias": [ "AdresInformatie", "Adresgegevens" ],
"max": "*",
"id": "Patient.address",
"condition": [ "ele-1", "nl-streetname-if-official-and-other-line-parts" ],
"comment": "Note: address is for postal addresses, not physical locations.",
"example": [ {
"label": "Example of a Vacation Home address",
"valueAddress": {
"use": "temp",
"city": "Amsterdam",
"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"
} ]
} ],
"state": "NH",
"country": "NLD",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType",
"valueCodeableConcept": {
"coding": [ {
"code": "HV",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Vakantie adres"
} ]
}
} ],
"postalCode": "1000AA"
}
}, {
"label": "Example of a Primary Home address",
"valueAddress": {
"use": "home",
"city": "Amsterdam",
"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"
} ]
} ],
"state": "NH",
"country": "NLD",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType",
"valueCodeableConcept": {
"coding": [ {
"code": "HP",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Officieel adres"
} ]
}
}, {
"url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
"valueBoolean": true
} ],
"postalCode": "1001AA"
}
} ],
"base": {
"max": "*",
"min": 0,
"path": "Patient.address"
}
}, {
"path": "Patient.maritalStatus",
"requirements": "Most, if not all systems capture it.",
"min": 0,
"definition": "This field contains a patient's most recent marital (civil) status. A person’s marital status according to the terms and definition in the Dutch civil code.",
"short": "MaritalStatus",
"mapping": [ {
"map": "PID-16",
"identity": "v2"
}, {
"map": "player[classCode=PSN]/maritalStatusCode",
"identity": "rim"
}, {
"map": ".patient.maritalStatusCode",
"identity": "cda"
}, {
"map": "NL-CM:7.9.2",
"comment": "MaritalStatus",
"identity": "hcim-maritalstatus-v1.2.1-2015EN"
}, {
"map": "NL-CM:7.9.2",
"comment": "MaritalStatus",
"identity": "hcim-maritalstatus-v3.0-2016EN"
}, {
"map": "NL-CM:7.9.2",
"comment": "MaritalStatus",
"identity": "hcim-maritalstatus-v3.0-2017EN"
}, {
"map": "NL-CM:7.13.7",
"comment": "FamilySituation",
"identity": "hcim-familysituation-v1.0-2015EN"
}, {
"map": "NL-CM:7.13.7",
"comment": "FamilySituation",
"identity": "hcim-familysituation-v3.0-2016EN"
}, {
"map": "NL-CM:7.13.7",
"comment": "FamilySituation",
"identity": "hcim-familysituation-v3.0-2017EN"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20171231000000"
}
},
"alias": [ "BurgerlijkeStaat" ],
"max": "1",
"id": "Patient.maritalStatus",
"base": {
"max": "1",
"min": 0,
"path": "Patient.maritalStatus"
}
}, {
"path": "Patient.multipleBirth[x]",
"requirements": "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.",
"min": 0,
"definition": "Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).",
"short": "MultipleBirthIndicator",
"mapping": [ {
"map": "PID-24 (bool), PID-25 (integer)",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "NL-CM:0.1.31",
"comment": "MultipleBirthIndicator",
"identity": "hcim-patient-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.31",
"comment": "MultipleBirthIndicator",
"identity": "hcim-patient-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.31",
"comment": "MultipleBirthIndicator",
"identity": "hcim-patient-v3.1-2017EN"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "integer"
} ],
"alias": [ "Meerlingindicator" ],
"max": "1",
"id": "Patient.multipleBirth[x]",
"comment": "Where the valueInteger is provided, the number is the birth number in the sequence.\nE.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3\nIf a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.multipleBirth[x]"
}
}, {
"path": "Patient.photo",
"requirements": "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.",
"min": 0,
"definition": "Image of the patient.",
"short": "Image of the patient",
"mapping": [ {
"map": "OBX-5 - needs a profile",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "*",
"id": "Patient.photo",
"base": {
"max": "*",
"min": 0,
"path": "Patient.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() | (children().count() > id.count())"
}, {
"key": "pat-1",
"human": "SHALL at least contain a contact's details or a reference to an organization",
"xpath": "exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)",
"source": "http://hl7.org/fhir/StructureDefinition/Patient",
"severity": "error",
"expression": "name.exists() or telecom.exists() or address.exists() or organization.exists()"
} ],
"path": "Patient.contact",
"requirements": "Need to track people you can contact about the patient.",
"min": 0,
"definition": "Contacts are related persons in some way, but not all related persons are contacts. The HCIM ContactPerson is designed to deal with both related persons and contacts. An HCIM ContactPerson who is a contact, is expected to have an NL-CM:3.1.2 Role primary contact ('Eerste relatie/contactpersoon') or secondary contact ('Tweede relatie/contactpersoon'). See Patient.contact.relationship in slice 'role'.",
"short": "ContactPerson",
"mapping": [ {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "NL-CM:3.1.1",
"comment": "Contact",
"identity": "hcim-contactperson-v1.2-2015EN"
}, {
"map": "NL-CM:3.1.1",
"comment": "Contact",
"identity": "hcim-contactperson-v3.0-2016EN"
}, {
"map": "NL-CM:3.1.1",
"comment": "Contact",
"identity": "hcim-contactperson-v3.1-2017EN"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"alias": [ "Contactpersoon" ],
"max": "*",
"id": "Patient.contact",
"comment": "Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact"
}
}, {
"path": "Patient.contact.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.extension",
"min": 0,
"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",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.contact.extension",
"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"
}
}, {
"path": "Patient.contact.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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.contact.modifierExtension",
"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"
},
"isSummary": true
}, {
"path": "Patient.contact.relationship",
"requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min": 0,
"definition": "The nature of the relationship between the patient and the contact person.",
"short": "The kind of relationship",
"mapping": [ {
"map": "NK1-7, NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
},
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactRelationship"
} ],
"description": "The nature of the relationship between a patient and a contact person for that patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0131"
}
},
"max": "*",
"id": "Patient.contact.relationship",
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact.relationship"
}
}, {
"path": "Patient.contact.relationship",
"requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min": 0,
"definition": "The nature of the relationship between the patient and the contact person.",
"short": "Relationship",
"mapping": [ {
"map": "NK1-7, NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "NL-CM:3.1.3",
"comment": "Relationship",
"identity": "hcim-contactperson-v1.2-2015EN"
}, {
"map": "NL-CM:3.1.3",
"comment": "Relationship",
"identity": "hcim-contactperson-v3.0-2016EN"
}, {
"map": "NL-CM:3.1.3",
"comment": "Relationship",
"identity": "hcim-contactperson-v3.1-2017EN"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "relationship",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20171231000000"
}
},
"alias": [ "Relatie" ],
"max": "*",
"id": "Patient.contact.relationship:relationship",
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact.relationship"
}
}, {
"path": "Patient.contact.relationship",
"requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min": 0,
"definition": "Expectation is to have at least one of primary contact ('Eerste relatie/contactpersoon') or secondary contact ('Tweede relatie/contactpersoon')",
"short": "Role",
"mapping": [ {
"map": "NK1-7, NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "NL-CM:3.1.2",
"comment": "Role",
"identity": "hcim-contactperson-v1.2-2015EN"
}, {
"map": "NL-CM:3.1.2",
"comment": "Role",
"identity": "hcim-contactperson-v3.0-2016EN"
}, {
"map": "NL-CM:3.1.2",
"comment": "Role",
"identity": "hcim-contactperson-v3.1-2017EN"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "role",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20171231000000"
}
},
"alias": [ "Rol" ],
"max": "*",
"id": "Patient.contact.relationship:role",
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact.relationship"
}
}, {
"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() | (children().count() > id.count())"
}, {
"key": "nl-core-humanname-1",
"human": "if you specify a prefix for an own name then an own name is also expected",
"xpath": "not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-name']",
"source": "http://hl7.org/fhir/StructureDefinition/Patient",
"severity": "error",
"expression": "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()"
}, {
"key": "nl-core-humanname-2",
"human": "if you specify a voorvoegsel for a partner name then a partner name is also expected",
"xpath": "not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-name']",
"source": "http://hl7.org/fhir/StructureDefinition/Patient",
"severity": "error",
"expression": "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()"
} ],
"path": "Patient.contact.name",
"requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.",
"min": 0,
"definition": "A human's name with the ability to identify parts and usage.",
"short": "NameInformation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XPN",
"identity": "v2"
}, {
"map": "EN (actually, PN)",
"identity": "rim"
}, {
"map": "ProviderName",
"identity": "servd"
}, {
"map": "NL-CM:0.1.6",
"comment": "NameInformation",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.6",
"comment": "NameInformation",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.1",
"comment": "NameInformation",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
}, {
"map": "02",
"comment": "Naam",
"identity": "BRP"
}, {
"map": "NL-CM:3.1.4",
"comment": "NameInformation",
"identity": "hcim-contactperson-v1.2-2015EN"
}, {
"map": "NL-CM:3.1.4",
"comment": "NameInformation",
"identity": "hcim-contactperson-v3.0-2016EN"
}, {
"map": "NL-CM:3.1.4",
"comment": "NameInformation",
"identity": "hcim-contactperson-v3.1-2017EN"
} ],
"type": [ {
"code": "HumanName",
"profile": "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname"
} ],
"alias": [ "Naamgegevens" ],
"max": "1",
"id": "Patient.contact.name",
"condition": [ "ele-1" ],
"comment": "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.\r\n\r\nThe 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.\r\n\r\n**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. \r\n\r\nThe 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 `.use` element. However, this specification allows for including all alternative representations in the _same_ HumanName instance, with the expectation that the extensions provide enough information for receiving systems to differentiate them. However, this means that contrary to the normal usage of this datatype, repetitions of `.given` names cannot be concatenated to get the full list of given names; the list might be a mix of full names, nicknames and initials.\r\n\r\nSince multiple implementations are based on this specification, sending systems are advised (but not required) to keep the approach with one HumanName instance, while receiving systems should be able to handle this one-instance approach. More specifically:\r\n\r\n* Sending and receiving systems SHOULD always use the specified extensions when using this datatype.\r\n* Sending systems are encouraged to populate the `.text` element to unambigiously communicate the person's name.\r\n* Sending systems are encouraged to send either the full given names or the initials, but not both. This alleviates the duplication of names in `.given`.\r\n* When a sending system uses the current one-instance approach for communicating multiple representations, `.use` MAY NOT be populated. After all, it is not possible to select a single `.use` when the instance contains different representations.\r\n* When a receiving system interprets the instance as the single-instance-multiple-representations approach, the `.given` names marked as initials SHOULD be interpreted as alternatives to the full given names. Note the underlying HCIM expects both the _list_ of full names and _list_ of initials to be a single string; there's no match for an initial to a full name. The instance SHOULD be regarded as using this approach when:\r\n * They encounter a single instance\r\n * And the `.use` element is absent\r\n * And all the name parts are differentiated using the specified extensions\r\n* In any other circumstance, receiving systems SHOULD interpret the usage as the normal use.\r\n\r\nExample: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas:\r\n\r\n* `.family` = \"Jongeneel-de Haas\"\r\n* `.given` = \"Irma\" (with `.given:iso21090EnQualifier` = _BR_)\r\n* `.family:humannameOwnName` = \"Jongeneel\"\r\n* `.family:humannamePartnerPrefix` = \"de \"\r\n* `.family:humannamePartnerName` = \"Haas\"",
"example": [ {
"label": "Structured HumanName (preferred above unstructured)",
"valueHumanName": {
"text": "Irma Jongeneel-de Haas",
"given": [ "Irma" ],
"_given": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCode": "CL"
} ]
} ],
"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"
} ]
},
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
"valueCode": "NL4"
} ]
}
}, {
"label": "Unstructured HumanName",
"valueHumanName": {
"text": "Irma Jongeneel-de Haas"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.name"
}
}, {
"path": "Patient.contact.name.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.name.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.contact.name.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.contact.name.extension",
"min": 0,
"definition": "A code that represents the preferred display order of the components of this human name.",
"short": "Preferred display order of name parts",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
} ],
"sliceName": "humannameAssemblyOrder",
"max": "*",
"id": "Patient.contact.name.extension:humannameAssemblyOrder",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.contact.name.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.extension:humannameAssemblyOrder.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.name.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.contact.name.extension:humannameAssemblyOrder.extension",
"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"
}
}, {
"path": "Patient.contact.name.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.extension:humannameAssemblyOrder.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.contact.name.extension.valueCode",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"sliceName": "valueCode",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "HumanNameAssemblyOrder"
} ],
"description": "A code that represents the preferred display order of the components of a human name",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-assembly-order"
}
},
"max": "1",
"id": "Patient.contact.name.extension:humannameAssemblyOrder.valueCode:valueCode",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.contact.name.use",
"requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min": 0,
"definition": "Identifies the purpose for this name.",
"isModifier": true,
"short": "usual | official | temp | nickname | anonymous | old | maiden",
"mapping": [ {
"map": "XPN.7, but often indicated by which field contains the name",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./NamePurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NameUse"
} ],
"description": "The use of a human name",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-use"
}
},
"max": "1",
"id": "Patient.contact.name.use",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.use"
},
"isSummary": true
}, {
"path": "Patient.contact.name.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "A full text representation of the name.",
"short": "Text representation of the full name",
"mapping": [ {
"map": "implied by XPN.11",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v1.2-2015EN"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v3.0-2016EN"
}, {
"map": "NL-CM:1.1.5",
"comment": "PayerName",
"identity": "hcim-payer-v3.1-2017EN"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.contact.name.text",
"comment": "Can provide both a text representation and structured parts.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.text"
},
"isSummary": true
}, {
"path": "Patient.contact.name.family",
"min": 0,
"definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
"short": "Surname",
"mapping": [ {
"map": "XPN.1/FN.1",
"identity": "v2"
}, {
"map": "./part[partType = FAM]",
"identity": "rim"
}, {
"map": "./FamilyName",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "surname", "Achternaam" ],
"max": "1",
"id": "Patient.contact.name.family",
"comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.family"
},
"isSummary": true
}, {
"path": "Patient.contact.name.family.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.family.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.name.family.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.contact.name.family.extension",
"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() | (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": "Patient.contact.name.family.extension",
"min": 0,
"definition": "The prefix portion (e.g. voorvoegsel) inclusive of the space between the prefix and the surname, if applicable, of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.",
"short": "PrefixOwnName",
"mapping": [ {
"map": "FN.2",
"identity": "v2"
}, {
"map": "ENXP where Qualifiers = (VV, R)",
"identity": "rim"
}, {
"map": "NL-CM:0.1.38",
"comment": "Prefix",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.38",
"comment": "Prefix",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.11",
"comment": "Prefix",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
} ],
"sliceName": "humannameOwnPrefix",
"alias": [ "VoorvoegselGeslachtsnaam" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannameOwnPrefix",
"condition": [ "ele-1" ],
"comment": "An example of a voorvoegsel is the \"van\" in \"Ludwig van Beethoven\". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.contact.name.family.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannameOwnPrefix.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.name.family.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.contact.name.family.extension:humannameOwnPrefix.extension",
"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"
}
}, {
"path": "Patient.contact.name.family.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannameOwnPrefix.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.contact.name.family.extension.valueString",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"sliceName": "valueString",
"max": "1",
"id": "Patient.contact.name.family.extension:humannameOwnPrefix.valueString:valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"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() | (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": "Patient.contact.name.family.extension",
"min": 0,
"definition": "The person’s official last name.",
"short": "OwnName",
"mapping": [ {
"map": "FN.3",
"identity": "v2"
}, {
"map": "ENXP where Qualifiers = (BR)",
"identity": "rim"
}, {
"map": "NL-CM:0.1.24",
"comment": "LastName",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.24",
"comment": "LastName",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.10",
"comment": "LastName",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
} ],
"sliceName": "humannameOwnName",
"alias": [ "Geslachtsnaam" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannameOwnName",
"condition": [ "ele-1" ],
"comment": "The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's \"maiden name\".",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.contact.name.family.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannameOwnName.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.name.family.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.contact.name.family.extension:humannameOwnName.extension",
"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"
}
}, {
"path": "Patient.contact.name.family.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannameOwnName.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.contact.name.family.extension.valueString",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"sliceName": "valueString",
"max": "1",
"id": "Patient.contact.name.family.extension:humannameOwnName.valueString:valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"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() | (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": "Patient.contact.name.family.extension",
"min": 0,
"definition": "Voorvoegsel derived from person's partner's surname inclusive of the space between the prefix and the surname, if applicable.",
"short": "PrefixSurname",
"mapping": [ {
"map": "FN.4",
"identity": "v2"
}, {
"map": "ENXP where Qualifiers = (VV, SP)",
"identity": "rim"
}, {
"map": "NL-CM:0.1.39",
"comment": "PartnerPrefix",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.39",
"comment": "PartnerPrefix",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.9",
"comment": "PartnerPrefix",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
} ],
"sliceName": "humannamePartnerPrefix",
"alias": [ "VoorvoegselGeslachtsnaamPartner" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannamePartnerPrefix",
"condition": [ "ele-1" ],
"comment": "An example of a voorvoegsel is the \"van\" in \"Ludwig van Beethoven\". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.contact.name.family.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannamePartnerPrefix.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.name.family.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.contact.name.family.extension:humannamePartnerPrefix.extension",
"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"
}
}, {
"path": "Patient.contact.name.family.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannamePartnerPrefix.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.contact.name.family.extension.valueString",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"sliceName": "valueString",
"max": "1",
"id": "Patient.contact.name.family.extension:humannamePartnerPrefix.valueString:valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"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() | (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": "Patient.contact.name.family.extension",
"min": 0,
"definition": "Partner’s official last name.",
"short": "LastNamePartner",
"mapping": [ {
"map": "FN.5",
"identity": "v2"
}, {
"map": "ENXP where Qualifiers = (SP)",
"identity": "rim"
}, {
"map": "NL-CM:0.1.25",
"comment": "PartnerLastName",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.25",
"comment": "PartnerLastName",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.8",
"comment": "PartnerLastName",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
} ],
"sliceName": "humannamePartnerName",
"alias": [ "GeslachtsnaamPartner" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannamePartnerName",
"condition": [ "ele-1" ],
"comment": "The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's \"maiden name\".",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.contact.name.family.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannamePartnerName.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.name.family.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.contact.name.family.extension:humannamePartnerName.extension",
"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"
}
}, {
"path": "Patient.contact.name.family.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.family.extension:humannamePartnerName.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.contact.name.family.extension.valueString",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"sliceName": "valueString",
"max": "1",
"id": "Patient.contact.name.family.extension:humannamePartnerName.valueString:valueString",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.contact.name.family.value",
"min": 0,
"definition": "The actual value",
"short": "Primitive value for string",
"type": [ {
"_code": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:string"
} ]
}
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.family.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
}
}, {
"path": "Patient.contact.name.given",
"min": 0,
"definition": "Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot.",
"short": "Given",
"mapping": [ {
"map": "XPN.2 + XPN.3",
"identity": "v2"
}, {
"map": "./part[partType = GIV]",
"identity": "rim"
}, {
"map": "./GivenNames",
"identity": "servd"
}, {
"map": "NL-CM:0.1.26",
"comment": "FirstNames. Qualifier 'BR'",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.35",
"comment": "Initials. Qualifier 'IN'",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.27",
"comment": "GivenName. Qualifier 'CL'",
"identity": "hcim-nameinformation-v2.0.1-2015EN"
}, {
"map": "02.10",
"comment": "Voornamen",
"identity": "BRP"
}, {
"map": "NL-CM:0.1.26",
"comment": "FirstNames. Qualifier 'BR'",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.35",
"comment": "Initials. Qualifier 'IN'",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:0.1.27",
"comment": "GivenName. Qualifier 'CL'",
"identity": "hcim-nameinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.4.4",
"comment": "FirstNames. Qualifier 'BR'",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
}, {
"map": "NL-CM:20.4.5",
"comment": "Initials. Qualifier 'IN'",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
}, {
"map": "NL-CM:20.4.6",
"comment": "GivenName. Qualifier 'CL'",
"identity": "hcim-nameinformation-v1.0.1-2017EN"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "first name", "middle name", "Voornamen", "Initialen", "Roepnaam" ],
"max": "*",
"id": "Patient.contact.name.given",
"comment": "Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. To be conformant to the HCIM for NameInformation, at least the following qualifiers SHALL be supported: _BR_, _IN_ and _CL_. The qualifier _BR_ maps to the HCIM concept FirstNames, _IN_ maps to Initials and _CL_ to GivenName.\r\n\r\nPlease see the compatibility note on the containing element as well!",
"orderMeaning": "Given Names appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.given"
},
"isSummary": true
}, {
"path": "Patient.contact.name.given.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"short": "xml:id (or equivalent in JSON)",
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.given.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.name.given.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.contact.name.given.extension",
"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() | (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": "Patient.contact.name.given.extension",
"min": 0,
"definition": "A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.",
"isModifier": false,
"short": "LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV",
"mapping": [ {
"map": "ENXP.qualifier",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
} ],
"sliceName": "iso21090EnQualifier",
"max": "1",
"id": "Patient.contact.name.given.extension:iso21090EnQualifier",
"condition": [ "ele-1" ],
"comment": "Used to indicate additional information about the name part and how it should be used.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.contact.name.given.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.given.extension:iso21090EnQualifier.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.name.given.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.contact.name.given.extension:iso21090EnQualifier.extension",
"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"
}
}, {
"path": "Patient.contact.name.given.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.given.extension:iso21090EnQualifier.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.contact.name.given.extension.valueCode",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"sliceName": "valueCode",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EntityNamePartQualifier"
} ],
"description": "A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-part-qualifier"
}
},
"max": "1",
"id": "Patient.contact.name.given.extension:iso21090EnQualifier.valueCode:valueCode",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.contact.name.given.value",
"min": 0,
"definition": "The actual value",
"short": "Primitive value for string",
"type": [ {
"_code": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:string"
} ]
}
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.name.given.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
}
}, {
"path": "Patient.contact.name.prefix",
"min": 0,
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
"short": "Parts that come before the name",
"mapping": [ {
"map": "XPN.5",
"identity": "v2"
}, {
"map": "./part[partType = PFX]",
"identity": "rim"
}, {
"map": "./TitleCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Patient.contact.name.prefix",
"orderMeaning": "Prefixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.prefix"
},
"isSummary": true
}, {
"path": "Patient.contact.name.suffix",
"min": 0,
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
"short": "Parts that come after the name",
"mapping": [ {
"map": "XPN/4",
"identity": "v2"
}, {
"map": "./part[partType = SFX]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Patient.contact.name.suffix",
"orderMeaning": "Suffixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.suffix"
},
"isSummary": true
}, {
"path": "Patient.contact.name.period",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"definition": "Indicates the period of time when this name was valid for the named person.",
"short": "Time period when name was/is in use",
"mapping": [ {
"map": "XPN.13 + XPN.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.contact.name.period",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.period"
},
"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() | (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": "Patient.contact.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "Contact information includes a person's telephone numbers and email addresses. This datatype defines a common basis for expressing all contact information around the world, but adds extensions to express Dutch contacts specifically, according to the HCIM ContactInformation (v1.0, 2017). A Dutch ContactPoint still is a proper FHIR ContactPoint, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. The table below explains how the HCIM concepts are mapped to the various FHIR elements. The HCIM code itself should also be included using the TelecomType extension.\r\n\r\n| HCIM | `.ext:TelecomType` | `.system` | `.use` |\r\n|----------------------------------------------------|:------------------:|:---------:|:--------:|\r\n| Primary Home Land Line | _LL_ | _phone_ | _home_ |\r\n| Temporary Land Line | _LL_ | _phone_ | _temp_ |\r\n| Primary Work Land Line | _LL_ | _phone_ | _work_ |\r\n| | | | |\r\n| Primary Home Fax | _FAX_ | _fax_ | _home_ |\r\n| Temporary Fax | _FAX_ | _fax_ | _temp_ |\r\n| Primary Work Fax | _FAX_ | _fax_ | _work_ |\r\n| | | | |\r\n| Primary Home Mobile Phone | _MC_ | _phone_ | _home_ |\r\n| Temporary Mobile Phone | _MC_ | _phone_ | _temp_ |\r\n| Primary Work Mobile Phone | _MC_ | _phone_ | _work_ |\r\n| | | | |\r\n| Primary Home Pager | _PG_ | _pager_ | _home_ |\r\n| Temporary Pager | _PG_ | _pager_ | _temp_ |\r\n| Primary Work Pager | _PG_ | _pager_ | _work_ |\r\n| | | | |\r\n| Private email address | | _email_ | _home_ |\r\n| Work email address | | _email_ | _work_ |\r\n| | | | |\r\n| Mobile phone number undetermined private/business | | _phone_ | _mobile_ |",
"short": "ContactInformation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XTN",
"identity": "v2"
}, {
"map": "TEL",
"identity": "rim"
}, {
"map": "ContactPoint",
"identity": "servd"
}, {
"map": "NL-CM:0.1.5",
"comment": "ContactInformation",
"identity": "hcim-contactinformation-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.5",
"comment": "ContactInformation",
"identity": "hcim-contactinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.6.1",
"comment": "ContactInformation",
"identity": "hcim-contactinformation-v1.0-2017EN"
}, {
"map": "NL-CM:3.1.6",
"comment": "TelephoneEmail::ContactInformation",
"identity": "hcim-contactperson-v1.2-2015EN"
}, {
"map": "NL-CM:3.1.6",
"comment": "TelephoneEmail::ContactInformation",
"identity": "hcim-contactperson-v3.0-2016EN"
}, {
"map": "NL-CM:3.1.6",
"comment": "ContactInformation",
"identity": "hcim-contactperson-v3.1-2017EN"
} ],
"type": [ {
"code": "ContactPoint",
"profile": "http://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint"
} ],
"alias": [ "Contactgegevens" ],
"max": "*",
"id": "Patient.contact.telecom",
"condition": [ "ele-1" ],
"comment": "Telecommunication data details (phone/email) is physically modeled in the HCIM Patient, which is why the telecommunication mappings appear to be coming from the HCIM Patient instead of the HCIM ContactPerson",
"example": [ {
"label": "Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.",
"valueContactPoint": {
"use": "work",
"value": "+31611234567",
"system": "phone"
}
}, {
"label": "Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.",
"valueContactPoint": {
"use": "mobile",
"value": "+31611234567",
"system": "phone"
}
}, {
"label": "Primary Home Land Line",
"valueContactPoint": {
"use": "home",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "LL",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Land Line"
} ]
}
} ]
}
}, {
"label": "Temporary Land Line",
"valueContactPoint": {
"use": "temp",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "LL",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Land Line"
} ]
}
} ]
}
}, {
"label": "Primary Work Land Line",
"valueContactPoint": {
"use": "work",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "LL",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Land Line"
} ]
}
} ]
}
}, {
"label": "Primary Home Fax",
"valueContactPoint": {
"use": "home",
"value": "...",
"system": "fax",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "FAX",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Fax"
} ]
}
} ]
}
}, {
"label": "Temporary Fax",
"valueContactPoint": {
"use": "temp",
"value": "...",
"system": "fax",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "FAX",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Fax"
} ]
}
} ]
}
}, {
"label": "Primary Work Fax",
"valueContactPoint": {
"use": "work",
"value": "...",
"system": "fax",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "FAX",
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1",
"display": "Fax"
} ]
}
} ]
}
}, {
"label": "Primary Home Mobile Phone",
"valueContactPoint": {
"use": "home",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "MC",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Mobile Phone"
} ]
}
} ]
}
}, {
"label": "Temporary Mobile Phone",
"valueContactPoint": {
"use": "temp",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "MC",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Mobile Phone"
} ]
}
} ]
}
}, {
"label": "Primary Work Mobile Phone",
"valueContactPoint": {
"use": "work",
"value": "...",
"system": "phone",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "MC",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Mobile Phone"
} ]
}
} ]
}
}, {
"label": "Primary Home Pager",
"valueContactPoint": {
"use": "home",
"value": "...",
"system": "pager",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "PG",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Pager"
} ]
}
} ]
}
}, {
"label": "Temporary Pager",
"valueContactPoint": {
"use": "temp",
"value": "...",
"system": "pager",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "PG",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Pager"
} ]
}
} ]
}
}, {
"label": "Primary Work Pager",
"valueContactPoint": {
"use": "work",
"value": "...",
"system": "pager",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType",
"valueCodeableConcept": {
"coding": [ {
"code": "PG",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Pager"
} ]
}
} ]
}
}, {
"label": "Private email address",
"valueContactPoint": {
"use": "home",
"value": "giesput@myweb.nl",
"system": "email"
}
}, {
"label": "Work email address",
"valueContactPoint": {
"use": "work",
"value": "example@workplace.nl",
"system": "email"
}
} ],
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact.telecom"
}
}, {
"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() | (children().count() > id.count())"
}, {
"key": "nl-streetname-if-official-and-other-line-parts",
"human": "Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value",
"xpath": "not(.[f:extension[@url='http://fhir.nl/fhir/StructureDefinition/nl-core-address-official'][f:valueBoolean/@value='true']][f:line[empty(f:extension[@url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName'])][f:extension[@url=('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator')]]])",
"source": "http://hl7.org/fhir/StructureDefinition/Patient",
"severity": "error",
"expression": "(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()))",
"requirements": "This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address"
} ],
"path": "Patient.contact.address",
"requirements": "Need to keep track where the contact person can be contacted per postal mail or visited.",
"min": 0,
"definition": "This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the HCIM AddressInformation (v1.0, 2017). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype.\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 HCIM defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the HCIM concepts are mapped to the various FHIR elements (see the ConceptMaps and as well). The HCIM code itself should also be included using the AddressType extension.\r\n\r\n| HCIM |` .ext:AddressType` | `.ext:official` | `.use` | `.type` |\r\n|-----------------------------------|:------------------:|:---------------:|:------:|:----------:|\r\n| Postal Address/Postadres | _PST_ | | | _postal_ |\r\n| Primary Home/Officieel adres | _HP_ | true | _home_ | |\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\n 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.\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 HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension.",
"short": "AddressInformation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XAD",
"identity": "v2"
}, {
"map": "AD",
"identity": "rim"
}, {
"map": "Address",
"identity": "servd"
}, {
"map": "NL-CM:0.1.4",
"comment": "AddressInformation",
"identity": "hcim-address-v2.0.1-2015EN"
}, {
"map": "NL-CM:0.1.4",
"comment": "AddressInformation",
"identity": "hcim-addressinformation-v3.0-2016EN"
}, {
"map": "NL-CM:20.5.1",
"comment": "AddressInformation",
"identity": "hcim-addressinformation-v1.0-2017EN"
}, {
"map": "NL-CM:3.1.5",
"comment": "AddressInformation",
"identity": "hcim-contactperson-v1.2-2015EN"
}, {
"map": "NL-CM:3.1.5",
"comment": "AddressInformation",
"identity": "hcim-contactperson-v3.0-2016EN"
}, {
"map": "NL-CM:3.1.5",
"comment": "AddressInformation",
"identity": "hcim-contactperson-v3.1-2017EN"
} ],
"type": [ {
"code": "Address",
"profile": "http://fhir.nl/fhir/StructureDefinition/nl-core-address"
} ],
"alias": [ "AdresInformatie", "Adresgegevens" ],
"max": "1",
"id": "Patient.contact.address",
"condition": [ "ele-1", "nl-streetname-if-official-and-other-line-parts" ],
"comment": "Note: address is for postal addresses, not physical locations.",
"example": [ {
"label": "Example of a Vacation Home address",
"valueAddress": {
"use": "temp",
"city": "Amsterdam",
"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"
} ]
} ],
"state": "NH",
"country": "NLD",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType",
"valueCodeableConcept": {
"coding": [ {
"code": "HV",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Vakantie adres"
} ]
}
} ],
"postalCode": "1000AA"
}
}, {
"label": "Example of a Primary Home address",
"valueAddress": {
"use": "home",
"city": "Amsterdam",
"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"
} ]
} ],
"state": "NH",
"country": "NLD",
"extension": [ {
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType",
"valueCodeableConcept": {
"coding": [ {
"code": "HP",
"system": "http://hl7.org/fhir/v3/AddressUse",
"display": "Officieel adres"
} ]
}
}, {
"url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
"valueBoolean": true
} ],
"postalCode": "1001AA"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.address"
}
}, {
"path": "Patient.contact.gender",
"requirements": "Needed to address the person correctly.",
"min": 0,
"definition": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.",
"short": "male | female | other | unknown",
"mapping": [ {
"map": "NK1-15",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
} ],
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"max": "1",
"id": "Patient.contact.gender",
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.gender"
}
}, {
"path": "Patient.contact.organization",
"requirements": "For guardians or business related contacts, the organization is relevant.",
"min": 0,
"definition": "Organization on behalf of which the contact is acting or for which the contact is working.",
"short": "Organization that is associated with the contact",
"mapping": [ {
"map": "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41",
"identity": "v2"
}, {
"map": "scoper",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Patient.contact.organization",
"condition": [ "pat-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.organization"
}
}, {
"path": "Patient.contact.period",
"min": 0,
"definition": "The period during which this contact person or organization is valid to be contacted relating to this patient.",
"short": "The period during which this contact person or organization is valid to be contacted relating to this patient",
"mapping": [ {
"map": "effectiveTime",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.contact.period",
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.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() | (children().count() > id.count())"
} ],
"path": "Patient.animal",
"requirements": "Many clinical systems are extended to care for animal patients as well as human.",
"min": 0,
"definition": "This patient is known to be an animal.",
"isModifier": true,
"short": "This patient is known to be an animal (non-human)",
"mapping": [ {
"map": "player[classCode=ANM]",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "Patient.animal",
"comment": "The animal element is labeled \"Is Modifier\" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.animal"
},
"isSummary": true
}, {
"path": "Patient.animal.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.animal.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.animal.extension",
"min": 0,
"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",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.animal.extension",
"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"
}
}, {
"path": "Patient.animal.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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.animal.modifierExtension",
"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"
},
"isSummary": true
}, {
"path": "Patient.animal.species",
"requirements": "Need to know what kind of animal.",
"min": 1,
"definition": "Identifies the high level taxonomic categorization of the kind of animal.",
"short": "E.g. Dog, Cow",
"mapping": [ {
"map": "PID-35",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AnimalSpecies"
} ],
"description": "The species of an animal.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/animal-species"
}
},
"max": "1",
"id": "Patient.animal.species",
"comment": "If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word \"Hereford\" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for \"Hereford Cattle Breed\" does.).",
"base": {
"max": "1",
"min": 1,
"path": "Patient.animal.species"
},
"isSummary": true
}, {
"path": "Patient.animal.breed",
"requirements": "May need to know the specific kind within the species.",
"min": 0,
"definition": "Identifies the detailed categorization of the kind of animal.",
"short": "E.g. Poodle, Angus",
"mapping": [ {
"map": "PID-37",
"identity": "v2"
}, {
"map": "playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AnimalBreed"
} ],
"description": "The breed of an animal.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/animal-breeds"
}
},
"max": "1",
"id": "Patient.animal.breed",
"comment": "Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.animal.breed"
},
"isSummary": true
}, {
"path": "Patient.animal.genderStatus",
"requirements": "Gender status can affect housing and animal behavior.",
"min": 0,
"definition": "Indicates the current state of the animal's reproductive organs.",
"short": "E.g. Neutered, Intact",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "genderStatusCode",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AnimalGenderStatus"
} ],
"description": "The state of the animal's reproductive organs.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/animal-genderstatus"
}
},
"max": "1",
"id": "Patient.animal.genderStatus",
"base": {
"max": "1",
"min": 0,
"path": "Patient.animal.genderStatus"
},
"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() | (children().count() > id.count())"
} ],
"path": "Patient.communication",
"requirements": "If a patient 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": "Languages which may be used to communicate with the patient about his or her health.",
"short": "A list of Languages which may be used to communicate with the patient about his or her health",
"mapping": [ {
"map": "LanguageCommunication",
"identity": "rim"
}, {
"map": "patient.languageCommunication",
"identity": "cda"
}, {
"map": "NL-CM:7.12.1",
"comment": "LanguageProficiency",
"identity": "hcim-languageproficiency-v3.1-2017EN"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"alias": [ "Taalvaardigheid" ],
"max": "*",
"id": "Patient.communication",
"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 Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient 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": "Patient.communication"
}
}, {
"path": "Patient.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.communication.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.communication.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.communication.extension",
"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() | (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": "Patient.communication.extension",
"min": 0,
"definition": "Proficiency level of the communication.",
"short": "Proficiency level of the communication",
"mapping": [ {
"map": "NL-CM:7.12.6",
"comment": "LanguageControlListening",
"identity": "hcim-languageproficiency-v3.1-2017EN"
}, {
"map": "NL-CM:7.12.7",
"comment": "LanguageControlSpeaking",
"identity": "hcim-languageproficiency-v3.1-2017EN"
}, {
"map": "NL-CM:7.12.8",
"comment": "LanguageControlReading",
"identity": "hcim-languageproficiency-v3.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://nictiz.nl/fhir/StructureDefinition/patient-proficiency"
} ],
"sliceName": "languageProficiency",
"max": "*",
"id": "Patient.communication.extension:languageProficiency",
"condition": [ "ele-1" ],
"comment": "The HCIM concepts LanguageControlListening, LanguageControlReading, LanguageControlSpeaking are captuperd using a mocked offical HL7 core extension from the R4 FHIR specification. Each of these three concepts is encoded as a copy of the extension, typed using the code in the type slice according to the following mapping:\r\n* LanguaneControlListening maps to code 'RSP' (Received spoken)\r\n* LanguageControlReading maps to code 'RWR' (Received written)\r\n* LanguageControlSpeaking maps to code 'ESP' (Expressed spoken)",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.communication.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.communication.extension:languageProficiency.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.communication.extension.extension",
"min": 2,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.communication.extension:languageProficiency.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.communication.extension.extension",
"min": 1,
"definition": "An Extension",
"short": "Extension",
"type": [ {
"code": "Extension"
} ],
"sliceName": "type",
"max": "1",
"id": "Patient.communication.extension:languageProficiency.extension:type",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.communication.extension.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.communication.extension:languageProficiency.extension:type.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.communication.extension.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.communication.extension:languageProficiency.extension:type.extension",
"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"
}
}, {
"path": "Patient.communication.extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "type",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.communication.extension:languageProficiency.extension:type.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.communication.extension.extension.value[x]",
"min": 1,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "closed",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "Patient.communication.extension:languageProficiency.extension:type.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.communication.extension.extension.value[x]",
"min": 1,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "valueCoding",
"binding": {
"strength": "extensible",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-LanguageAbilityMode"
}
},
"max": "1",
"id": "Patient.communication.extension:languageProficiency.extension:type.value[x]:valueCoding",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.communication.extension.extension",
"min": 1,
"definition": "An Extension",
"short": "Extension",
"type": [ {
"code": "Extension"
} ],
"sliceName": "level",
"max": "1",
"id": "Patient.communication.extension:languageProficiency.extension:level",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.communication.extension.extension.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.communication.extension:languageProficiency.extension:level.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.communication.extension.extension.extension",
"min": 0,
"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",
"mapping": [ {
"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"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.communication.extension:languageProficiency.extension:level.extension",
"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"
}
}, {
"path": "Patient.communication.extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "level",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.communication.extension:languageProficiency.extension:level.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.communication.extension.extension.value[x]",
"min": 1,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "closed",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "Patient.communication.extension:languageProficiency.extension:level.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.communication.extension.extension.value[x]",
"min": 1,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "valueCoding",
"binding": {
"strength": "extensible",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-LanguageAbilityProficiency"
}
},
"max": "1",
"id": "Patient.communication.extension:languageProficiency.extension:level.value[x]:valueCoding",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Patient.communication.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://nictiz.nl/fhir/StructureDefinition/patient-proficiency",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.communication.extension:languageProficiency.url",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Patient.communication.extension.value[x]",
"min": 0,
"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",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "0",
"id": "Patient.communication.extension:languageProficiency.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"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() | (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": "Patient.communication.extension",
"min": 0,
"definition": "An Extension",
"short": "Comment",
"mapping": [ {
"map": "NL-CM:7.12.5",
"comment": "Comment",
"identity": "hcim-languageproficiency-v3.1-2017EN"
} ],
"type": [ {
"code": "Extension",
"profile": "http://nictiz.nl/fhir/StructureDefinition/Comment"
} ],
"sliceName": "comment",
"alias": [ "Toelichting" ],
"max": "*",
"id": "Patient.communication.extension:comment",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.communication.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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.communication.modifierExtension",
"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"
},
"isSummary": true
}, {
"path": "Patient.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 language of communication. \r\n\r\nThe 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": "CommunicationLanguage",
"mapping": [ {
"map": "PID-15, LAN-2",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code",
"identity": "rim"
}, {
"map": ".languageCode",
"identity": "cda"
}, {
"map": "NL-CM:7.12.3",
"comment": "CommunicationLanguage",
"identity": "hcim-languageproficiency-v3.1-2017EN"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"alias": [ "CommunicatieTaal" ],
"max": "1",
"id": "Patient.communication.language",
"comment": "The FHIR value set http://hl7.org/fhir/valueset-languages.html is used instead of the HCIM value set CommunicationLanguageCodelist. The FHIR value set uses the code system urn:ietf:bcp:47 which includes the ISO-639-2 alpha code system used by the HCIM value set.",
"base": {
"max": "1",
"min": 1,
"path": "Patient.communication.language"
}
}, {
"path": "Patient.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": "PID-15",
"identity": "v2"
}, {
"map": "preferenceInd",
"identity": "rim"
}, {
"map": ".preferenceInd",
"identity": "cda"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Patient.communication.preferred",
"comment": "This language is specifically identified for communicating healthcare information.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.communication.preferred"
}
}, {
"path": "Patient.generalPractitioner",
"min": 0,
"definition": "Patient's nominated care provider.",
"short": "GeneralPractitioner",
"mapping": [ {
"map": "PD1-4",
"identity": "v2"
}, {
"map": "subjectOf.CareEvent.performer.AssignedEntity",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "NL-CM:17.2.1",
"comment": "HealthcareProvider",
"identity": "hcim-healthcareprovider-v1.2-2015EN"
}, {
"map": "NL-CM:17.2.1",
"comment": "HealthcareProvider",
"identity": "hcim-healthcareprovider-v3.0-2016EN"
}, {
"map": "NL-CM:17.2.1",
"comment": "HealthcareProvider",
"identity": "hcim-healthcareprovider-v3.1.1-2017EN"
}, {
"map": "NL-CM:17.1.1",
"comment": "HealthProfessional",
"identity": "hcim-healthprofessional-v1.2.1-2015EN"
}, {
"map": "NL-CM:17.1.1",
"comment": "HealthProfessional",
"identity": "hcim-healthprofessional-v3.0-2016EN"
}, {
"map": "NL-CM:17.1.1",
"comment": "HealthProfessional",
"identity": "hcim-healthprofessional-v3.2-2017EN"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-organization"
}, {
"code": "Reference",
"targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner"
} ],
"alias": [ "careProvider", "Huisarts" ],
"max": "1",
"id": "Patient.generalPractitioner",
"comment": "This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles.\n\nIt is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.generalPractitioner"
}
}, {
"path": "Patient.generalPractitioner.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.generalPractitioner.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.generalPractitioner.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.generalPractitioner.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.generalPractitioner.extension",
"min": 0,
"definition": "Optional Extension Element - found in all resources.",
"short": "Optional Extensions Element",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference"
} ],
"sliceName": "practitionerRole",
"max": "1",
"id": "Patient.generalPractitioner.extension:practitionerRole",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.generalPractitioner.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.generalPractitioner.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "Patient.generalPractitioner.identifier",
"min": 0,
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Patient.generalPractitioner.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "Patient.generalPractitioner.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Patient.generalPractitioner.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "Patient.managingOrganization",
"requirements": "Need to know who recognizes this patient record, manages and updates it.",
"min": 0,
"definition": "Organization that is the custodian of the patient record.",
"short": "Organization that is the custodian of the patient record",
"mapping": [ {
"map": "scoper",
"identity": "rim"
}, {
"map": ".providerOrganization",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.managingOrganization",
"comment": "There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.managingOrganization"
},
"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() | (children().count() > id.count())"
} ],
"path": "Patient.link",
"requirements": "There are multiple usecases: \n\n* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.",
"min": 0,
"definition": "Link to another patient resource that concerns the same actual patient.",
"isModifier": true,
"short": "Link to another patient resource that concerns the same actual person",
"mapping": [ {
"map": "outboundLink",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Patient.link",
"comment": "There is no assumption that linked patient records have mutual links. \n\nThis element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.link"
},
"isSummary": true
}, {
"path": "Patient.link.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": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.link.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.link.extension",
"min": 0,
"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",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.link.extension",
"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"
}
}, {
"path": "Patient.link.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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.link.modifierExtension",
"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"
},
"isSummary": true
}, {
"path": "Patient.link.other",
"min": 1,
"definition": "The other patient resource that the link refers to.",
"short": "The other patient or related person resource that the link refers to",
"mapping": [ {
"map": "PID-3, MRG-1",
"identity": "v2"
}, {
"map": "id",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
} ],
"max": "1",
"id": "Patient.link.other",
"comment": "Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.",
"base": {
"max": "1",
"min": 1,
"path": "Patient.link.other"
},
"isSummary": true
}, {
"path": "Patient.link.type",
"min": 1,
"definition": "The type of link between this patient resource and another patient resource.",
"short": "replaced-by | replaces | refer | seealso - type of link",
"mapping": [ {
"map": "typeCode",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "LinkType"
} ],
"description": "The type of link between this patient resource and another patient resource.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/link-type"
}
},
"max": "1",
"id": "Patient.link.type",
"base": {
"max": "1",
"min": 1,
"path": "Patient.link.type"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "364d6095-c8f1-47c0-8345-15b313174335",
"kind": "resource",
"url": "http://hl7.nl/fhir/zorgviewer/StructureDefinition/Patient",
"version": "1.2.0",
"differential": {
"element": [ {
"id": "Patient",
"path": "Patient"
}, {
"id": "Patient.identifier:BSN",
"min": 1,
"path": "Patient.identifier",
"sliceName": "BSN",
"mustSupport": true
}, {
"id": "Patient.name",
"min": 1,
"path": "Patient.name",
"constraint": [ {
"key": "zv-pat-1",
"human": "Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present.",
"xpath": "/f:name/f:family or /f:name/f:given or /f:name/f:text",
"severity": "error",
"expression": "(family.exists() or given.exists() or text.exists())"
}, {
"key": "zv-pat-2",
"human": "To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.",
"xpath": "/f:name/f:text",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
} ],
"expression": "text.exists()"
} ],
"mustSupport": true
}, {
"id": "Patient.gender",
"path": "Patient.gender",
"mustSupport": true
}, {
"id": "Patient.birthDate",
"path": "Patient.birthDate",
"mustSupport": true
}, {
"id": "Patient.deceased[x]",
"path": "Patient.deceased[x]",
"mustSupport": true
}, {
"id": "Patient.managingOrganization",
"path": "Patient.managingOrganization",
"mustSupport": true
} ]
},
"contact": [ {
"name": "RIVO-NN",
"telecom": [ {
"value": "https://rivo-noord.nl",
"system": "url"
} ]
}, {
"name": "HL7NL",
"telecom": [ {
"value": "https://hl7.nl",
"system": "url"
} ]
} ],
"baseDefinition": "http://fhir.nl/fhir/StructureDefinition/nl-core-patient"
}