{ "resourceType": "StructureDefinition", "id": "HdBe-Patient", "meta": { "lastUpdated": "2023-05-08T17:11:08.6472828+00:00" }, "url": "https://fhir.healthdata.be/StructureDefinition/HdBe-Patient", "name": "HdBePatient", "title": "HdBe Patient", "status": "draft", "experimental": false, "publisher": "Healthdata.be (Sciensano)", "contact": [ { "name": "Service portal – healthdata.be", "telecom": [ { "system": "url", "value": "https://sciensano.service-now.com/sp", "use": "work" } ] } ], "description": "A person who receives medical, psychological, paramedical or nursing care. In some care settings, the term client or participant is used instead of the term patient.\r\nNationality is used as an indication of the country of citizenship. \r\nMarital status is a person’s formal position as defined by the Belgian civil code. There is a distinction between marriage and civil union.", "copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "HdBe-Patient", "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-Patient", "name": "HdBe logical model Patient" }, { "identity": "zib-patient-v3.2-2020EN", "uri": "https://zibs.nl/wiki/Patient-v3.2(2020EN)", "name": "zib Patient-v3.2(2020EN)" }, { "identity": "HdBe-Nationality", "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-Nationality", "name": "HdBe logical model Nationality" }, { "identity": "zib-nationality-v3.0-2020EN", "uri": "https://zibs.nl/wiki/Nationality-v3.0(2020EN)", "name": "zib Nationality-v3.0(2020EN)" }, { "identity": "HdBe-MaritalStatus", "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-MaritalStatus", "name": "HdBe logical model MaritalStatus" }, { "identity": "zib-maritalstatus-v3.1-2020EN", "uri": "https://zibs.nl/wiki/MaritalStatus-v3.1(2020EN)", "name": "zib MaritalStatus-v3.1(2020EN)" }, { "identity": "HdBe-LanguageProficiency", "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-LanguageProficiency", "name": "HdBe logical model LanguageProficiency" }, { "identity": "zib-languageproficiency-v3.2-2020EN", "uri": "https://zibs.nl/wiki/LanguageProficiency-v3.2(2020EN)", "name": "zib LanguageProficiency-v3.2(2020EN)" }, { "identity": "HdBe-ContactInformation", "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-ContactInformation", "name": "HdBe logical model ContactInformation" }, { "identity": "zib-contactinformation-v1.2-2020EN", "uri": "https://zibs.nl/wiki/ContactInformation-v1.2(2020EN)", "name": "zib ContactInformation-v1.2(2020EN)" }, { "identity": "HdBe-ContactPerson", "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-ContactPerson", "name": "HdBe logical model ContactPerson" }, { "identity": "zib-contactperson-v3.4-2020EN", "uri": "https://zibs.nl/wiki/ContactPerson-v3.4(2020EN)", "name": "zib ContactPerson-v3.4(2020EN)" } ], "kind": "resource", "abstract": false, "type": "Patient", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient", "derivation": "constraint", "snapshot": { "element": [ { "id": "Patient", "path": "Patient", "short": "Patient", "definition": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.", "alias": [ "SubjectOfCare Client Resident", "Patient" ], "min": 0, "max": "*", "base": { "path": "Patient", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "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" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "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" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Patient[classCode=PAT]" }, { "identity": "cda", "map": "ClinicalDocument.recordTarget.patientRole" }, { "identity": "w5", "map": "administrative.individual" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.1", "comment": "Patient" }, { "identity": "HdBe-Patient", "map": "Patient" } ] }, { "id": "Patient.id", "path": "Patient.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "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.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.meta", "path": "Patient.meta", "short": "Metadata about the resource", "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.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.implicitRules", "path": "Patient.implicitRules", "short": "A set of rules under which this content was created", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.language", "path": "Patient.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "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" } ], "strength": "extensible", "description": "A human language." }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.text", "path": "Patient.text", "short": "Text summary of the resource, for human interpretation", "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.", "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.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "ele-1", "dom-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Patient.contained", "path": "Patient.contained", "short": "Contained, inline Resources", "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.", "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension", "path": "Patient.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality", "path": "Patient.extension", "sliceName": "nationality", "short": "Nationality", "definition": "The nationality of the patient.", "comment": "Due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time), the cardinality of the extension is left at 0..* instead of the CBB cardinality of 0..1.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-nationality" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.id", "path": "Patient.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.extension:nationality.extension", "path": "Patient.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.extension:code", "path": "Patient.extension.extension", "sliceName": "code", "short": "Nationality Code", "definition": "Code representing nationality of patient.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.extension:code.id", "path": "Patient.extension.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.extension:nationality.extension:code.extension", "path": "Patient.extension.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.extension:code.url", "path": "Patient.extension.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a 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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "code", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.extension:code.value[x]", "path": "Patient.extension.extension.value[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" }, "short": "Nationality", "definition": "Indicates the country of citizenship.", "alias": [ "Nationaliteit" ], "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "strength": "extensible", "description": "Iso 3166 Part 1: 2 Letter Codes", "valueSet": "https://fhir.healthdata.be/ValueSet/CountryISO" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "zib-nationality-v3.0-2020EN", "map": "NL-CM:7.6.3", "comment": "Nationality" }, { "identity": "HdBe-Nationality", "map": "NationalityRC.Nationality" } ] }, { "id": "Patient.extension:nationality.extension:code.value[x]:valueCodeableConcept", "path": "Patient.extension.extension.value[x]", "sliceName": "valueCodeableConcept", "short": "Value of extension", "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).", "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.extension:period", "path": "Patient.extension.extension", "sliceName": "period", "short": "Nationality Period", "definition": "Period when nationality was effective.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.extension:period.id", "path": "Patient.extension.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.extension:nationality.extension:period.extension", "path": "Patient.extension.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.extension:period.url", "path": "Patient.extension.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a 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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "period", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.extension:period.value[x]", "path": "Patient.extension.extension.value[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" }, "short": "Value of extension", "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).", "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.extension:period.value[x]:valuePeriod", "path": "Patient.extension.extension.value[x]", "sliceName": "valuePeriod", "short": "Value of extension", "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).", "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.url", "path": "Patient.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a 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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-nationality", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.extension:nationality.value[x]", "path": "Patient.extension.value[x]", "short": "Value of extension", "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).", "min": 0, "max": "0", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "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" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.modifierExtension", "path": "Patient.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.identifier", "path": "Patient.identifier", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "short": "PatientIdentificationNumber", "definition": "The patient’s identification number. Typically, when an social security identification number (NISS-INSZ), is available it is used. A local identifier may be provided when this is desired.", "requirements": "Patients are almost always assigned specific numerical identifiers.", "alias": [ "Identificatienummer" ], "min": 0, "max": "*", "base": { "path": "Patient.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": "id" }, { "identity": "cda", "map": ".id" }, { "identity": "w5", "map": "id" }, { "identity": "HdBe-Patient", "map": "Patient.PatientIdentificationNumber" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.7", "comment": "PatientIdentificationNumber" } ] }, { "id": "Patient.identifier:SSIN", "path": "Patient.identifier", "sliceName": "SSIN", "short": "An identifier for this patient", "definition": "An identifier for this patient according to SSIN (NISS-INSZ.)", "requirements": "Patients are almost always assigned specific numerical identifiers.", "min": 0, "max": "*", "base": { "path": "Patient.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "patternIdentifier": { "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin" }, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": "id" }, { "identity": "cda", "map": ".id" }, { "identity": "w5", "map": "id" } ] }, { "id": "Patient.active", "path": "Patient.active", "short": "Whether this patient's record is in active use", "definition": "Whether this patient record is in active use.", "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.", "requirements": "Need to be able to mark a patient record as not to be used because it was created in error.", "min": 0, "max": "1", "base": { "path": "Patient.active", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "defaultValueBoolean": true, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "statusCode" }, { "identity": "cda", "map": "n/a" }, { "identity": "w5", "map": "status" } ] }, { "id": "Patient.name", "path": "Patient.name", "slicing": { "discriminator": [ { "type": "value", "path": "use" } ], "rules": "open" }, "short": "NameInformation", "definition": "Patient's full name.", "comment": "A patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.", "requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.", "alias": [ "Naamgegevens" ], "min": 0, "max": "*", "base": { "path": "Patient.name", "min": 0, "max": "*" }, "type": [ { "code": "HumanName" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XPN" }, { "identity": "rim", "map": "EN (actually, PN)" }, { "identity": "servd", "map": "ProviderName" }, { "identity": "v2", "map": "PID-5, PID-9" }, { "identity": "rim", "map": "name" }, { "identity": "cda", "map": ".patient.name" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.6", "comment": "NameInformation" }, { "identity": "HdBe-Patient", "map": "Patient.NameInformation" } ] }, { "id": "Patient.name:nameInformation", "path": "Patient.name", "sliceName": "nameInformation", "short": "NameInformation", "definition": "This slice represents the person's official name information, including given names, last name and possibly the partner's last name.", "comment": "This `.name` element represents a Belgian name according to the CBB NameInformation (except for the GivenName concept). A Belgian name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Belgian rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Belgian context SHOULD support these extensions as specified here. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Belgian contexts. It is encouraged to provide a representation of the full name in the `.text` element.\r\n\r\n**Note 1**: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept.\r\n\r\n**Note 2**: This element should only contain a person's _official_ names. The GivenName concept is represented in another `.name` element with `.name.use` = _usual_.\r\n\r\n**Note 3**: The examples illustrate how the CBB is mapped to FHIR.", "requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.", "alias": [ "Naamgegevens" ], "min": 0, "max": "2", "base": { "path": "Patient.name", "min": 0, "max": "*" }, "type": [ { "code": "HumanName", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "zib-NameInformation-1", "severity": "error", "human": "If a prefix for a familiy name is specified, the family name is expected as well", "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()", "source": "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation" }, { "key": "zib-NameInformation-2", "severity": "error", "human": "If the prefix for a partner family name is specified, the partner family name is expected as well", "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()", "source": "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XPN" }, { "identity": "rim", "map": "EN (actually, PN)" }, { "identity": "servd", "map": "ProviderName" }, { "identity": "v2", "map": "PID-5, PID-9" }, { "identity": "rim", "map": "name" }, { "identity": "cda", "map": ".patient.name" }, { "identity": "zib-nameinformation-v1.1-2020EN", "map": "NL-CM:20.4.1", "comment": "NameInformation" }, { "identity": "HdBe-NameInformation", "map": "NameInformation" } ] }, { "id": "Patient.name:nameInformation-GivenName", "path": "Patient.name", "sliceName": "nameInformation-GivenName", "short": "Name of a human - parts and usage", "definition": "This slice represents the name information normally used to address the person.", "comment": "This `.name` element represents the Belgian given name (\"roepnaam\") according to the CBB NameInformation.\r\n\r\n**Note 1**: This element should only contain a person's _unofficial_ name. The official names are represented in one or more other `.name` elements with `.name.use` = _official_.\r\n\r\n**Note 2**: The examples illustrate how the CBB is mapped to FHIR.", "requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.", "min": 0, "max": "*", "base": { "path": "Patient.name", "min": 0, "max": "*" }, "type": [ { "code": "HumanName", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation.GivenName" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XPN" }, { "identity": "rim", "map": "EN (actually, PN)" }, { "identity": "servd", "map": "ProviderName" }, { "identity": "v2", "map": "PID-5, PID-9" }, { "identity": "rim", "map": "name" }, { "identity": "cda", "map": ".patient.name" } ] }, { "id": "Patient.telecom", "path": "Patient.telecom", "short": "ContactInformation", "definition": "Patient’s telephone number(s) or e-mail address(es).", "comment": "Implementation of the CBB ContactInformation.\r\n\r\nPlease note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.", "requirements": "People have (primary) ways to contact them in some way such as phone, email.", "alias": [ "Contactpunten", "Contactgegevens" ], "min": 0, "max": "*", "base": { "path": "Patient.telecom", "min": 0, "max": "*" }, "type": [ { "code": "ContactPoint", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactInformation" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "cpt-2", "severity": "error", "human": "A system is required if a value is provided.", "expression": "value.empty() or system.exists()", "xpath": "not(exists(f:value)) or exists(f:system)", "source": "http://hl7.org/fhir/StructureDefinition/ContactPoint" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XTN" }, { "identity": "rim", "map": "TEL" }, { "identity": "servd", "map": "ContactPoint" }, { "identity": "v2", "map": "PID-13, PID-14, PID-40" }, { "identity": "rim", "map": "telecom" }, { "identity": "cda", "map": ".telecom" }, { "identity": "zib-contactinformation-v1.2-2020EN", "map": "NL-CM:20.6.2", "comment": "TelephoneNumbers" }, { "identity": "zib-contactinformation-v1.2-2020EN", "map": "NL-CM:20.6.3", "comment": "EmailAddresses" }, { "identity": "HdBe-ContactInformation", "map": "ContactInformation" }, { "identity": "HdBe-Patient", "map": "Patient.ContactInformation" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.5", "comment": "ContactInformation" }, { "identity": "zib-contactinformation-v1.2-2020EN", "map": "NL-CM:20.6.1", "comment": "ContactInformation" } ] }, { "id": "Patient.gender", "path": "Patient.gender", "short": "Gender", "definition": "Patient’s administrative gender. The gender that that the patient is considered to have for administration and record keeping purposes. Note that the gender might not match the biological sex as determined by genetics or the individual's preferred identification. The Observation resource can deal with specific sex or gender aspect of interest.", "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.", "requirements": "Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.", "alias": [ "Geslacht" ], "min": 0, "max": "1", "base": { "path": "Patient.gender", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdministrativeGender" } ], "strength": "required", "description": "Use ConceptMap 'GenderCodelijst-to-AdministrativeGender' to translate CBB terminology to profile terminology in ValueSet 'AdministrativeGender'", "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1", "_valueSet": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap", "valueCanonical": "https://fhir.healthdata.be/ConceptMap/Gender-to-AdministrativeGender" } ] } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "PID-8" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender" }, { "identity": "cda", "map": ".patient.administrativeGenderCode" }, { "identity": "HdBe-Patient", "map": "Patient.Gender" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.9", "comment": "Gender" } ] }, { "id": "Patient.gender.id", "path": "Patient.gender.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.gender.extension", "path": "Patient.gender.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.gender.extension:genderCodelist", "path": "Patient.gender.extension", "sliceName": "genderCodelist", "short": "Optional Extensions Element", "definition": "Optional Extension Element - found in all resources.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.gender.extension:genderCodelist.id", "path": "Patient.gender.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.gender.extension:genderCodelist.extension", "path": "Patient.gender.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.gender.extension:genderCodelist.url", "path": "Patient.gender.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a 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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.gender.extension:genderCodelist.value[x]", "path": "Patient.gender.extension.value[x]", "short": "Gender", "definition": "Patient’s administrative gender.", "alias": [ "Geslacht" ], "min": 0, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "strength": "required", "description": "GenderCodelist", "valueSet": "https://fhir.healthdata.be/ValueSet/Gender" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "HdBe-Patient", "map": "Patient.Gender" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.9", "comment": "Gender" } ] }, { "id": "Patient.gender.value", "path": "Patient.gender.value", "representation": [ "xmlAttr" ], "short": "Primitive value for code", "definition": "Primitive value for code", "min": 0, "max": "1", "base": { "path": "string.value", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex", "valueString": "[^\\s]+([\\s]?[^\\s]+)*" } ], "_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" } ] } } ], "maxLength": 1048576 }, { "id": "Patient.birthDate", "path": "Patient.birthDate", "short": "DateOfBirth", "definition": "Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted.", "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).", "requirements": "Age of the individual drives many clinical processes.", "alias": [ "Geboortedatum" ], "min": 0, "max": "1", "base": { "path": "Patient.birthDate", "min": 0, "max": "1" }, "type": [ { "code": "date" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "PID-7" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime" }, { "identity": "cda", "map": ".patient.birthTime" }, { "identity": "loinc", "map": "21112-8" }, { "identity": "HdBe-Patient", "map": "Patient.DateOfBirth" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.10", "comment": "DateOfBirth" } ] }, { "id": "Patient.deceased[x]", "path": "Patient.deceased[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" }, "short": "Indicates if the individual is deceased or not", "definition": "Indicates if the individual is deceased or not.", "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.", "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, "max": "1", "base": { "path": "Patient.deceased[x]", "min": 0, "max": "1" }, "type": [ { "code": "boolean" }, { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "PID-30 (bool) and PID-29 (datetime)" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.deceased[x]:deceasedBoolean", "path": "Patient.deceased[x]", "sliceName": "deceasedBoolean", "short": "DeathIndicator", "definition": "An indication stating whether the patient has died.", "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.", "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.", "alias": [ "OverlijdensIndicator" ], "min": 0, "max": "1", "base": { "path": "Patient.deceased[x]", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "PID-30 (bool) and PID-29 (datetime)" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime" }, { "identity": "cda", "map": "n/a" }, { "identity": "HdBe-Patient", "map": "Patient.DeathIndicator" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.32", "comment": "DeathIndicator" } ] }, { "id": "Patient.deceased[x]:deceasedDateTime", "path": "Patient.deceased[x]", "sliceName": "deceasedDateTime", "short": "DateOfDeath", "definition": "The date on which the patient died. A ‘vague’ date, such as only the year, is permitted.", "comment": "The CBB recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true.", "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.", "alias": [ "DatumOverlijden", "OverlijdensIndicator" ], "min": 0, "max": "1", "base": { "path": "Patient.deceased[x]", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "PID-30 (bool) and PID-29 (datetime)" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime" }, { "identity": "cda", "map": "n/a" }, { "identity": "HdBe-Patient", "map": "Patient.DateOfDeath" }, { "identity": "HdBe-Patient", "map": "Patient.DeathIndicator" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.33", "comment": "DateOfDeath" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.32", "comment": "DeathIndicator" } ] }, { "id": "Patient.address", "path": "Patient.address", "short": "AddressInformation", "definition": "Patient's address information.", "comment": "Note: address is for postal addresses, not physical locations.", "requirements": "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.", "alias": [ "Adresgegevens" ], "min": 0, "max": "*", "base": { "path": "Patient.address", "min": 0, "max": "*" }, "type": [ { "code": "Address", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-AddressInformation" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD" }, { "identity": "rim", "map": "AD" }, { "identity": "servd", "map": "Address" }, { "identity": "v2", "map": "PID-11" }, { "identity": "rim", "map": "addr" }, { "identity": "cda", "map": ".addr" }, { "identity": "zib-addressinformation-v1.1-2020EN", "map": "NL-CM:20.5.1", "comment": "AddressInformation" }, { "identity": "HdBe-AddressInformation", "map": "AddressInformation" }, { "identity": "HdBe-Patient", "map": "Patient.AddressInformation" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.4", "comment": "AddressInformation" } ] }, { "id": "Patient.maritalStatus", "path": "Patient.maritalStatus", "short": "MaritalStatus", "definition": "A person’s marital status.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "requirements": "Most, if not all systems capture it.", "alias": [ "BurgerlijkeStaat" ], "min": 0, "max": "1", "base": { "path": "Patient.maritalStatus", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MaritalStatus" } ], "strength": "required", "description": "Use ConceptMap 'BeCivilstate-to-MaritalStatus' to translate CBB terminology to profile terminology in ValueSet 'MaritalStatus'", "valueSet": "https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-civilstate", "_valueSet": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap", "valueCanonical": "https://fhir.healthdata.be/ConceptMap/BeCivilstate-to-MaritalStatus" } ] } }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "PID-16" }, { "identity": "rim", "map": "player[classCode=PSN]/maritalStatusCode" }, { "identity": "cda", "map": ".patient.maritalStatusCode" }, { "identity": "HdBe-MaritalStatus", "map": "MaritalStatusRC.MaritalStatus" }, { "identity": "zib-maritalstatus-v3.1-2020EN", "map": "NL-CM:7.9.2", "comment": "MaritalStatus" } ] }, { "id": "Patient.multipleBirth[x]", "path": "Patient.multipleBirth[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" }, "short": "Whether patient is part of a multiple birth", "definition": "Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).", "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).", "requirements": "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.", "min": 0, "max": "1", "base": { "path": "Patient.multipleBirth[x]", "min": 0, "max": "1" }, "type": [ { "code": "boolean" }, { "code": "integer" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "PID-24 (bool), PID-25 (integer)" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.multipleBirth[x]:multipleBirthBoolean", "path": "Patient.multipleBirth[x]", "sliceName": "multipleBirthBoolean", "short": "MultipleBirthIndicator", "definition": "An indication stating whether the patient is of a multiple birth.", "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).", "requirements": "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.", "alias": [ "MeerlingIndicator" ], "min": 0, "max": "1", "base": { "path": "Patient.multipleBirth[x]", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "PID-24 (bool), PID-25 (integer)" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber" }, { "identity": "cda", "map": "n/a" }, { "identity": "HdBe-Patient", "map": "Patient.MultipleBirthIndicator" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.31", "comment": "MultipleBirthIndicator" } ] }, { "id": "Patient.multipleBirth[x]:multipleBirthInteger", "path": "Patient.multipleBirth[x]", "sliceName": "multipleBirthInteger", "short": "MultipleBirthOrder", "definition": "An indication of the birth order in case the patient is of a multiple birth.", "comment": "The CBB recognizes both the MultipleBirthIndicator (boolean) and MultipleBirthOrder (integer) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if multipleBirthInteger is present and has a value, its value can be mapped to MultipleBirthOrder and MultipleBirthIndicator is assumed to be true.", "requirements": "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.", "min": 0, "max": "1", "base": { "path": "Patient.multipleBirth[x]", "min": 0, "max": "1" }, "type": [ { "code": "integer" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "PID-24 (bool), PID-25 (integer)" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber" }, { "identity": "cda", "map": "n/a" }, { "identity": "HdBe-Patient", "map": "Patient.MultipleBirthOrder" }, { "identity": "HdBe-Patient", "map": "Patient.MultipleBirthIndicator" } ] }, { "id": "Patient.photo", "path": "Patient.photo", "short": "Image of the patient", "definition": "Image of the patient.", "comment": "When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as \"Attachment\".", "requirements": "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.", "min": 0, "max": "*", "base": { "path": "Patient.photo", "min": 0, "max": "*" }, "type": [ { "code": "Attachment" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "att-1", "severity": "error", "human": "It the Attachment has data, it SHALL have a contentType", "expression": "data.empty() or contentType.exists()", "xpath": "not(exists(f:data)) or exists(f:contentType)", "source": "http://hl7.org/fhir/StructureDefinition/Attachment" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ED/RP" }, { "identity": "rim", "map": "ED" }, { "identity": "v2", "map": "OBX-5 - needs a profile" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.contact", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Contact" } ], "path": "Patient.contact", "short": "Contact", "definition": "A contact party (e.g. guardian, partner, friend) for the patient.", "comment": "Whereas the CBB ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons:\r\n\r\n* The RelatedPerson resource is used to capture information about any person that is related to the patient, using the profile .\r\n* Information about persons that should be _contacted_ regarding the care for the patient is captured using the `Patient.contact` resource.\r\n\r\nIf a person is both a related person and a contact person, then some data duplication is inevitable. The HdBe-ContactPerson can be referenced using the extension in `contact:contactPerson`.", "requirements": "Need to track people you can contact about the patient.", "alias": [ "Contactpersoon" ], "min": 0, "max": "*", "base": { "path": "Patient.contact", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "pat-1", "severity": "error", "human": "SHALL at least contain a contact's details or a reference to an organization", "expression": "name.exists() or telecom.exists() or address.exists() or organization.exists()", "xpath": "exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)", "source": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]" }, { "identity": "cda", "map": "n/a" }, { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.1", "comment": "Contact" }, { "identity": "HdBe-ContactPerson", "map": "Contact" } ] }, { "id": "Patient.contact.id", "path": "Patient.contact.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.contact.extension", "path": "Patient.contact.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.contact.extension:contactPerson", "path": "Patient.contact.extension", "sliceName": "contactPerson", "short": "This contact may have further details in this RelatedPerson", "definition": "In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.contact.extension:contactPerson.id", "path": "Patient.contact.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.contact.extension:contactPerson.extension", "path": "Patient.contact.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.contact.extension:contactPerson.url", "path": "Patient.contact.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a 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.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.contact.extension:contactPerson.value[x]", "path": "Patient.contact.extension.value[x]", "short": "Contact", "definition": "Reference to a [HdBe-ContactPerson](https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson) instance containing the full details for the current contact.", "alias": [ "Contactpersoon" ], "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.1", "comment": "Contact" }, { "identity": "HdBe-ContactPerson", "map": "Contact" } ] }, { "id": "Patient.contact.modifierExtension", "path": "Patient.contact.modifierExtension", "short": "Extensions that cannot be ignored", "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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.contact.relationship", "path": "Patient.contact.relationship", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "short": "The kind of relationship", "definition": "The nature of the relationship between the patient and the contact person.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.", "min": 0, "max": "*", "base": { "path": "Patient.contact.relationship", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactRelationship" } ], "strength": "extensible", "description": "The nature of the relationship between a patient and a contact person for that patient." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "NK1-7, NK1-3" }, { "identity": "rim", "map": "code" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.contact.relationship:role", "path": "Patient.contact.relationship", "sliceName": "role", "short": "Role", "definition": "Defines the role of the contact in relation to the patient.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.", "alias": [ "Rol" ], "min": 0, "max": "*", "base": { "path": "Patient.contact.relationship", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactRelationship" } ], "strength": "required", "description": "RolCodelijst", "valueSet": "https://fhir.healthdata.be/ValueSet/Role" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "NK1-7, NK1-3" }, { "identity": "rim", "map": "code" }, { "identity": "cda", "map": "n/a" }, { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.2", "comment": "Role" }, { "identity": "HdBe-ContactPerson", "map": "Role" } ] }, { "id": "Patient.contact.relationship:relationship", "path": "Patient.contact.relationship", "sliceName": "relationship", "short": "Relationship", "definition": "Defines the contact’s familial relationship to the patient.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.", "alias": [ "Relatie" ], "min": 0, "max": "*", "base": { "path": "Patient.contact.relationship", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactRelationship" } ], "strength": "required", "description": "RelatieCodelijst", "valueSet": "https://fhir.healthdata.be/ValueSet/Relationship" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "NK1-7, NK1-3" }, { "identity": "rim", "map": "code" }, { "identity": "cda", "map": "n/a" }, { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.3", "comment": "Relationship" }, { "identity": "HdBe-ContactPerson", "map": "Relationship" } ] }, { "id": "Patient.contact.name", "path": "Patient.contact.name", "short": "NameInformation", "definition": "Full name of the contact.", "comment": "This element can and should not completely capture the NameInformation concept from the CBB ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full name information should instead be captured using an instance of [HdBe-ContactPerson](https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson), which can then be referenced from this resource. See the comment on `Patient.contact` for more information.", "requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.", "alias": [ "Naamgegevens" ], "min": 0, "max": "1", "base": { "path": "Patient.contact.name", "min": 0, "max": "1" }, "type": [ { "code": "HumanName", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "zib-NameInformation-1", "severity": "error", "human": "If a prefix for a familiy name is specified, the family name is expected as well", "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()", "source": "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation" }, { "key": "zib-NameInformation-2", "severity": "error", "human": "If the prefix for a partner family name is specified, the partner family name is expected as well", "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()", "source": "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XPN" }, { "identity": "rim", "map": "EN (actually, PN)" }, { "identity": "servd", "map": "ProviderName" }, { "identity": "v2", "map": "NK1-2" }, { "identity": "rim", "map": "name" }, { "identity": "cda", "map": "n/a" }, { "identity": "zib-nameinformation-v1.1-2020EN", "map": "NL-CM:20.4.1", "comment": "NameInformation" }, { "identity": "HdBe-NameInformation", "map": "NameInformation" }, { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.4", "comment": "NameInformation" }, { "identity": "HdBe-ContactPerson", "map": "NameInformation" } ] }, { "id": "Patient.contact.telecom", "path": "Patient.contact.telecom", "short": "ContactInformation", "definition": "The contact’s telephone number and/or e-mail address.", "comment": "Implementation of the CBB ContactInformation.\r\n\r\nPlease note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.", "requirements": "People have (primary) ways to contact them in some way such as phone, email.", "alias": [ "Contactpunten", "Contactgegevens" ], "min": 0, "max": "*", "base": { "path": "Patient.contact.telecom", "min": 0, "max": "*" }, "type": [ { "code": "ContactPoint", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactInformation" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "cpt-2", "severity": "error", "human": "A system is required if a value is provided.", "expression": "value.empty() or system.exists()", "xpath": "not(exists(f:value)) or exists(f:system)", "source": "http://hl7.org/fhir/StructureDefinition/ContactPoint" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XTN" }, { "identity": "rim", "map": "TEL" }, { "identity": "servd", "map": "ContactPoint" }, { "identity": "v2", "map": "NK1-5, NK1-6, NK1-40" }, { "identity": "rim", "map": "telecom" }, { "identity": "cda", "map": "n/a" }, { "identity": "zib-contactinformation-v1.2-2020EN", "map": "NL-CM:20.6.2", "comment": "TelephoneNumbers" }, { "identity": "zib-contactinformation-v1.2-2020EN", "map": "NL-CM:20.6.3", "comment": "EmailAddresses" }, { "identity": "HdBe-ContactInformation", "map": "ContactInformation" }, { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.6", "comment": "ContactInformation" }, { "identity": "zib-contactinformation-v1.2-2020EN", "map": "NL-CM:20.6.1", "comment": "ContactInformation" }, { "identity": "HdBe-ContactPerson", "map": "ContactInformation" } ] }, { "id": "Patient.contact.address", "path": "Patient.contact.address", "short": "AddressInformation", "definition": "Contact’s address information.", "comment": "This element can and should not completely capture the AddressInformation concept from CBB ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full address information should instead be captured using an instance of [HdBe-ContactPerson](https://fhir.healthdata.be/StructureDefintion/HdBe-ContactPerson), which can then be referenced from this resource. See the comment on `Patient.contact` for more information.", "requirements": "Need to keep track where the contact person can be contacted per postal mail or visited.", "alias": [ "Adresgegevens" ], "min": 0, "max": "1", "base": { "path": "Patient.contact.address", "min": 0, "max": "1" }, "type": [ { "code": "Address", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-AddressInformation" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD" }, { "identity": "rim", "map": "AD" }, { "identity": "servd", "map": "Address" }, { "identity": "v2", "map": "NK1-4" }, { "identity": "rim", "map": "addr" }, { "identity": "cda", "map": "n/a" }, { "identity": "zib-addressinformation-v1.1-2020EN", "map": "NL-CM:20.5.1", "comment": "AddressInformation" }, { "identity": "HdBe-AddressInformation", "map": "AddressInformation" }, { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.5", "comment": "AddressInformation" }, { "identity": "HdBe-ContactPerson", "map": "AddressInformation" } ] }, { "id": "Patient.contact.gender", "path": "Patient.contact.gender", "short": "male | female | other | unknown", "definition": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.", "comment": "Note that FHIR strings may not exceed 1MB in size", "requirements": "Needed to address the person correctly.", "min": 0, "max": "1", "base": { "path": "Patient.contact.gender", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdministrativeGender" } ], "strength": "required", "description": "The gender of a person used for administrative purposes." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "NK1-15" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.contact.organization", "path": "Patient.contact.organization", "short": "Organization that is associated with the contact", "definition": "Organization on behalf of which the contact is acting or for which the contact is working.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "requirements": "For guardians or business related contacts, the organization is relevant.", "min": 0, "max": "1", "base": { "path": "Patient.contact.organization", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "condition": [ "ele-1", "pat-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "v2", "map": "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41" }, { "identity": "rim", "map": "scoper" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.contact.period", "path": "Patient.contact.period", "short": "The period during which this contact person or organization is valid to be contacted relating to this patient", "definition": "The period during which this contact person or organization is valid to be contacted relating to this patient.", "comment": "This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\"). If duration is required, specify the type as Interval|Duration.", "min": 0, "max": "1", "base": { "path": "Patient.contact.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower value than end", "expression": "start.empty() or end.empty() or (start <= end)", "xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)", "source": "http://hl7.org/fhir/StructureDefinition/Period" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "rim", "map": "effectiveTime" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.animal", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Animal" } ], "path": "Patient.animal", "short": "This patient is known to be an animal (non-human)", "definition": "This patient is known to be an 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).", "requirements": "Many clinical systems are extended to care for animal patients as well as human.", "min": 0, "max": "1", "base": { "path": "Patient.animal", "min": 0, "max": "1" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "player[classCode=ANM]" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.animal.id", "path": "Patient.animal.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.animal.extension", "path": "Patient.animal.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.animal.modifierExtension", "path": "Patient.animal.modifierExtension", "short": "Extensions that cannot be ignored", "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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.animal.species", "path": "Patient.animal.species", "short": "E.g. Dog, Cow", "definition": "Identifies the high level taxonomic categorization of the kind of animal.", "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.).", "requirements": "Need to know what kind of animal.", "min": 1, "max": "1", "base": { "path": "Patient.animal.species", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AnimalSpecies" } ], "strength": "example", "description": "The species of an animal." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "PID-35" }, { "identity": "rim", "map": "code" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.animal.breed", "path": "Patient.animal.breed", "short": "E.g. Poodle, Angus", "definition": "Identifies the detailed categorization of the kind of animal.", "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.", "requirements": "May need to know the specific kind within the species.", "min": 0, "max": "1", "base": { "path": "Patient.animal.breed", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AnimalBreed" } ], "strength": "example", "description": "The breed of an animal." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "PID-37" }, { "identity": "rim", "map": "playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.animal.genderStatus", "path": "Patient.animal.genderStatus", "short": "E.g. Neutered, Intact", "definition": "Indicates the current state of the animal's reproductive organs.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "requirements": "Gender status can affect housing and animal behavior.", "min": 0, "max": "1", "base": { "path": "Patient.animal.genderStatus", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AnimalGenderStatus" } ], "strength": "example", "description": "The state of the animal's reproductive organs." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "genderStatusCode" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.communication", "path": "Patient.communication", "short": "A list of Languages which may be used to communicate with the patient about his or her health", "definition": "Languages which may be used to communicate with the patient about his or her health.", "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.", "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, "max": "*", "base": { "path": "Patient.communication", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "LanguageCommunication" }, { "identity": "cda", "map": "patient.languageCommunication" } ] }, { "id": "Patient.communication.id", "path": "Patient.communication.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.communication.extension", "path": "Patient.communication.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.communication.modifierExtension", "path": "Patient.communication.modifierExtension", "short": "Extensions that cannot be ignored", "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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.communication.language", "path": "Patient.communication.language", "short": "The language which can be used to communicate with the patient about his or her health", "definition": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.", "comment": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.", "requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.", "min": 1, "max": "1", "base": { "path": "Patient.communication.language", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "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" } ], "strength": "extensible", "description": "A human language." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "PID-15, LAN-2" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code" }, { "identity": "cda", "map": ".languageCode" } ] }, { "id": "Patient.communication.preferred", "path": "Patient.communication.preferred", "short": "Language preference indicator", "definition": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).", "comment": "This language is specifically identified for communicating healthcare information.", "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, "max": "1", "base": { "path": "Patient.communication.preferred", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "PID-15" }, { "identity": "rim", "map": "preferenceInd" }, { "identity": "cda", "map": ".preferenceInd" } ] }, { "id": "Patient.generalPractitioner", "path": "Patient.generalPractitioner", "short": "Patient's nominated primary care provider", "definition": "Patient's nominated care provider.", "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.", "alias": [ "careProvider" ], "min": 0, "max": "*", "base": { "path": "Patient.generalPractitioner", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "v2", "map": "PD1-4" }, { "identity": "rim", "map": "subjectOf.CareEvent.performer.AssignedEntity" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.managingOrganization", "path": "Patient.managingOrganization", "short": "Organization that is the custodian of the patient record", "definition": "Organization that is the custodian of the patient record.", "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).", "requirements": "Need to know who recognizes this patient record, manages and updates it.", "min": 0, "max": "1", "base": { "path": "Patient.managingOrganization", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": "scoper" }, { "identity": "cda", "map": ".providerOrganization" } ] }, { "id": "Patient.link", "path": "Patient.link", "short": "Link to another patient resource that concerns the same actual person", "definition": "Link to another patient resource that concerns the same actual patient.", "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'.", "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, "max": "*", "base": { "path": "Patient.link", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "outboundLink" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.link.id", "path": "Patient.link.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Patient.link.extension", "path": "Patient.link.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.link.modifierExtension", "path": "Patient.link.modifierExtension", "short": "Extensions that cannot be ignored", "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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Patient.link.other", "path": "Patient.link.other", "short": "The other patient or related person resource that the link refers to", "definition": "The other patient resource that the link refers to.", "comment": "Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.", "min": 1, "max": "1", "base": { "path": "Patient.link.other", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "v2", "map": "PID-3, MRG-1" }, { "identity": "rim", "map": "id" }, { "identity": "cda", "map": "n/a" } ] }, { "id": "Patient.link.type", "path": "Patient.link.type", "short": "replaced-by | replaces | refer | seealso - type of link", "definition": "The type of link between this patient resource and another patient resource.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 1, "max": "1", "base": { "path": "Patient.link.type", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "LinkType" } ], "strength": "required", "description": "The type of link between this patient resource and another patient resource." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "typeCode" }, { "identity": "cda", "map": "n/a" } ] } ] }, "differential": { "element": [ { "id": "Patient", "path": "Patient", "short": "Patient", "alias": [ "Patient" ], "mapping": [ { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.1", "comment": "Patient" }, { "identity": "HdBe-Patient", "map": "Patient" } ] }, { "id": "Patient.extension", "path": "Patient.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "Patient.extension:nationality", "path": "Patient.extension", "sliceName": "nationality", "comment": "Due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time), the cardinality of the extension is left at 0..* instead of the CBB cardinality of 0..1.", "min": 0, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-nationality" ] } ] }, { "id": "Patient.extension:nationality.extension", "path": "Patient.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "Patient.extension:nationality.extension:code", "path": "Patient.extension.extension", "sliceName": "code", "min": 0 }, { "id": "Patient.extension:nationality.extension:code.value[x]", "path": "Patient.extension.extension.value[x]", "short": "Nationality", "definition": "Indicates the country of citizenship.", "alias": [ "Nationaliteit" ], "binding": { "strength": "extensible", "description": "Iso 3166 Part 1: 2 Letter Codes", "valueSet": "https://fhir.healthdata.be/ValueSet/CountryISO" }, "mapping": [ { "identity": "zib-nationality-v3.0-2020EN", "map": "NL-CM:7.6.3", "comment": "Nationality" }, { "identity": "HdBe-Nationality", "map": "NationalityRC.Nationality" } ] }, { "id": "Patient.identifier", "path": "Patient.identifier", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "short": "PatientIdentificationNumber", "definition": "The patient’s identification number. Typically, when an social security identification number (NISS-INSZ), is available it is used. A local identifier may be provided when this is desired.", "alias": [ "Identificatienummer" ], "mapping": [ { "identity": "HdBe-Patient", "map": "Patient.PatientIdentificationNumber" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.7", "comment": "PatientIdentificationNumber" } ] }, { "id": "Patient.identifier:SSIN", "path": "Patient.identifier", "sliceName": "SSIN", "definition": "An identifier for this patient according to SSIN (NISS-INSZ.)", "patternIdentifier": { "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin" } }, { "id": "Patient.name", "path": "Patient.name", "slicing": { "discriminator": [ { "type": "value", "path": "use" } ], "rules": "open" }, "short": "NameInformation", "definition": "Patient's full name.", "alias": [ "Naamgegevens" ], "mapping": [ { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.6", "comment": "NameInformation" }, { "identity": "HdBe-Patient", "map": "Patient.NameInformation" } ] }, { "id": "Patient.name:nameInformation", "path": "Patient.name", "sliceName": "nameInformation", "max": "2", "type": [ { "code": "HumanName", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation" ] } ] }, { "id": "Patient.name:nameInformation-GivenName", "path": "Patient.name", "sliceName": "nameInformation-GivenName", "type": [ { "code": "HumanName", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation.GivenName" ] } ] }, { "id": "Patient.telecom", "path": "Patient.telecom", "short": "ContactInformation", "definition": "Patient’s telephone number(s) or e-mail address(es).", "alias": [ "Contactgegevens" ], "type": [ { "code": "ContactPoint", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactInformation" ] } ], "mapping": [ { "identity": "HdBe-Patient", "map": "Patient.ContactInformation" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.5", "comment": "ContactInformation" }, { "identity": "zib-contactinformation-v1.2-2020EN", "map": "NL-CM:20.6.1", "comment": "ContactInformation" } ] }, { "id": "Patient.gender", "path": "Patient.gender", "short": "Gender", "definition": "Patient’s administrative gender. The gender that that the patient is considered to have for administration and record keeping purposes. Note that the gender might not match the biological sex as determined by genetics or the individual's preferred identification. The Observation resource can deal with specific sex or gender aspect of interest.", "alias": [ "Geslacht" ], "binding": { "strength": "required", "description": "Use ConceptMap 'GenderCodelijst-to-AdministrativeGender' to translate CBB terminology to profile terminology in ValueSet 'AdministrativeGender'", "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1", "_valueSet": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap", "valueCanonical": "https://fhir.healthdata.be/ConceptMap/Gender-to-AdministrativeGender" } ] } }, "mapping": [ { "identity": "HdBe-Patient", "map": "Patient.Gender" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.9", "comment": "Gender" } ] }, { "id": "Patient.gender.extension", "path": "Patient.gender.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "Patient.gender.extension:genderCodelist", "path": "Patient.gender.extension", "sliceName": "genderCodelist", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification" ] } ] }, { "id": "Patient.gender.extension:genderCodelist.value[x]", "path": "Patient.gender.extension.value[x]", "short": "Gender", "definition": "Patient’s administrative gender.", "alias": [ "Geslacht" ], "binding": { "strength": "required", "description": "GenderCodelist", "valueSet": "https://fhir.healthdata.be/ValueSet/Gender" }, "mapping": [ { "identity": "HdBe-Patient", "map": "Patient.Gender" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.9", "comment": "Gender" } ] }, { "id": "Patient.birthDate", "path": "Patient.birthDate", "short": "DateOfBirth", "definition": "Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted.", "alias": [ "Geboortedatum" ], "mapping": [ { "identity": "HdBe-Patient", "map": "Patient.DateOfBirth" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.10", "comment": "DateOfBirth" } ] }, { "id": "Patient.deceased[x]", "path": "Patient.deceased[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" } }, { "id": "Patient.deceased[x]:deceasedBoolean", "path": "Patient.deceased[x]", "sliceName": "deceasedBoolean", "short": "DeathIndicator", "definition": "An indication stating whether the patient has died.", "alias": [ "OverlijdensIndicator" ], "type": [ { "code": "boolean" } ], "mapping": [ { "identity": "HdBe-Patient", "map": "Patient.DeathIndicator" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.32", "comment": "DeathIndicator" } ] }, { "id": "Patient.deceased[x]:deceasedDateTime", "path": "Patient.deceased[x]", "sliceName": "deceasedDateTime", "short": "DateOfDeath", "definition": "The date on which the patient died. A ‘vague’ date, such as only the year, is permitted.", "comment": "The CBB recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true.", "alias": [ "DatumOverlijden", "OverlijdensIndicator" ], "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "HdBe-Patient", "map": "Patient.DateOfDeath" }, { "identity": "HdBe-Patient", "map": "Patient.DeathIndicator" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.33", "comment": "DateOfDeath" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.32", "comment": "DeathIndicator" } ] }, { "id": "Patient.address", "path": "Patient.address", "definition": "Patient's address information.", "type": [ { "code": "Address", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-AddressInformation" ] } ], "mapping": [ { "identity": "HdBe-Patient", "map": "Patient.AddressInformation" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.4", "comment": "AddressInformation" } ] }, { "id": "Patient.maritalStatus", "path": "Patient.maritalStatus", "short": "MaritalStatus", "definition": "A person’s marital status.", "alias": [ "BurgerlijkeStaat" ], "binding": { "strength": "required", "description": "Use ConceptMap 'BeCivilstate-to-MaritalStatus' to translate CBB terminology to profile terminology in ValueSet 'MaritalStatus'", "valueSet": "https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-civilstate", "_valueSet": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap", "valueCanonical": "https://fhir.healthdata.be/ConceptMap/BeCivilstate-to-MaritalStatus" } ] } }, "mapping": [ { "identity": "HdBe-MaritalStatus", "map": "MaritalStatusRC.MaritalStatus" }, { "identity": "zib-maritalstatus-v3.1-2020EN", "map": "NL-CM:7.9.2", "comment": "MaritalStatus" } ] }, { "id": "Patient.multipleBirth[x]", "path": "Patient.multipleBirth[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "open" } }, { "id": "Patient.multipleBirth[x]:multipleBirthBoolean", "path": "Patient.multipleBirth[x]", "sliceName": "multipleBirthBoolean", "short": "MultipleBirthIndicator", "definition": "An indication stating whether the patient is of a multiple birth.", "alias": [ "MeerlingIndicator" ], "type": [ { "code": "boolean" } ], "mapping": [ { "identity": "HdBe-Patient", "map": "Patient.MultipleBirthIndicator" }, { "identity": "zib-patient-v3.2-2020EN", "map": "NL-CM:0.1.31", "comment": "MultipleBirthIndicator" } ] }, { "id": "Patient.multipleBirth[x]:multipleBirthInteger", "path": "Patient.multipleBirth[x]", "sliceName": "multipleBirthInteger", "short": "MultipleBirthOrder", "definition": "An indication of the birth order in case the patient is of a multiple birth.", "comment": "The CBB recognizes both the MultipleBirthIndicator (boolean) and MultipleBirthOrder (integer) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if multipleBirthInteger is present and has a value, its value can be mapped to MultipleBirthOrder and MultipleBirthIndicator is assumed to be true.", "type": [ { "code": "integer" } ], "mapping": [ { "identity": "HdBe-Patient", "map": "Patient.MultipleBirthOrder" }, { "identity": "HdBe-Patient", "map": "Patient.MultipleBirthIndicator" } ] }, { "id": "Patient.contact", "path": "Patient.contact", "short": "Contact", "comment": "Whereas the CBB ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons:\r\n\r\n* The RelatedPerson resource is used to capture information about any person that is related to the patient, using the profile .\r\n* Information about persons that should be _contacted_ regarding the care for the patient is captured using the `Patient.contact` resource.\r\n\r\nIf a person is both a related person and a contact person, then some data duplication is inevitable. The HdBe-ContactPerson can be referenced using the extension in `contact:contactPerson`.", "alias": [ "Contactpersoon" ], "mapping": [ { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.1", "comment": "Contact" }, { "identity": "HdBe-ContactPerson", "map": "Contact" } ] }, { "id": "Patient.contact.extension", "path": "Patient.contact.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "Patient.contact.extension:contactPerson", "path": "Patient.contact.extension", "sliceName": "contactPerson", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" ] } ] }, { "id": "Patient.contact.extension:contactPerson.value[x]", "path": "Patient.contact.extension.value[x]", "short": "Contact", "definition": "Reference to a [HdBe-ContactPerson](https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson) instance containing the full details for the current contact.", "alias": [ "Contactpersoon" ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson" ] } ], "mapping": [ { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.1", "comment": "Contact" }, { "identity": "HdBe-ContactPerson", "map": "Contact" } ] }, { "id": "Patient.contact.relationship", "path": "Patient.contact.relationship", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" } }, { "id": "Patient.contact.relationship:role", "path": "Patient.contact.relationship", "sliceName": "role", "short": "Role", "definition": "Defines the role of the contact in relation to the patient.", "alias": [ "Rol" ], "binding": { "strength": "required", "description": "RolCodelijst", "valueSet": "https://fhir.healthdata.be/ValueSet/Role" }, "mapping": [ { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.2", "comment": "Role" }, { "identity": "HdBe-ContactPerson", "map": "Role" } ] }, { "id": "Patient.contact.relationship:relationship", "path": "Patient.contact.relationship", "sliceName": "relationship", "short": "Relationship", "definition": "Defines the contact’s familial relationship to the patient.", "alias": [ "Relatie" ], "binding": { "strength": "required", "description": "RelatieCodelijst", "valueSet": "https://fhir.healthdata.be/ValueSet/Relationship" }, "mapping": [ { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.3", "comment": "Relationship" }, { "identity": "HdBe-ContactPerson", "map": "Relationship" } ] }, { "id": "Patient.contact.name", "path": "Patient.contact.name", "definition": "Full name of the contact.", "comment": "This element can and should not completely capture the NameInformation concept from the CBB ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full name information should instead be captured using an instance of [HdBe-ContactPerson](https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson), which can then be referenced from this resource. See the comment on `Patient.contact` for more information.", "type": [ { "code": "HumanName", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation" ] } ], "mapping": [ { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.4", "comment": "NameInformation" }, { "identity": "HdBe-ContactPerson", "map": "NameInformation" } ] }, { "id": "Patient.contact.telecom", "path": "Patient.contact.telecom", "short": "ContactInformation", "definition": "The contact’s telephone number and/or e-mail address.", "alias": [ "Contactgegevens" ], "type": [ { "code": "ContactPoint", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactInformation" ] } ], "mapping": [ { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.6", "comment": "ContactInformation" }, { "identity": "zib-contactinformation-v1.2-2020EN", "map": "NL-CM:20.6.1", "comment": "ContactInformation" }, { "identity": "HdBe-ContactPerson", "map": "ContactInformation" } ] }, { "id": "Patient.contact.address", "path": "Patient.contact.address", "definition": "Contact’s address information.", "comment": "This element can and should not completely capture the AddressInformation concept from CBB ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full address information should instead be captured using an instance of [HdBe-ContactPerson](https://fhir.healthdata.be/StructureDefintion/HdBe-ContactPerson), which can then be referenced from this resource. See the comment on `Patient.contact` for more information.", "type": [ { "code": "Address", "profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-AddressInformation" ] } ], "mapping": [ { "identity": "zib-contactperson-v3.4-2020EN", "map": "NL-CM:3.1.5", "comment": "AddressInformation" }, { "identity": "HdBe-ContactPerson", "map": "AddressInformation" } ] } ] } }