{
"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.",
"_filename": "HdBe-Patient.json",
"package_name": "healthdata.be.r4.cbb",
"date": null,
"derivation": "constraint",
"meta": {
"lastUpdated": "2022-12-13T09:47:21.7895743+00:00"
},
"publisher": "Healthdata.be (Sciensano)",
"fhirVersion": "4.0.1",
"name": "HdBePatient",
"mapping": [ {
"uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-Patient",
"name": "HdBe logical model Patient",
"identity": "HdBe-Patient"
}, {
"uri": "https://zibs.nl/wiki/Patient-v3.2(2020EN)",
"name": "zib Patient-v3.2(2020EN)",
"identity": "zib-patient-v3.2-2020EN"
}, {
"uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-Nationality",
"name": "HdBe logical model Nationality",
"identity": "HdBe-Nationality"
}, {
"uri": "https://zibs.nl/wiki/Nationality-v3.0(2020EN)",
"name": "zib Nationality-v3.0(2020EN)",
"identity": "zib-nationality-v3.0-2020EN"
}, {
"uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-MaritalStatus",
"name": "HdBe logical model MaritalStatus",
"identity": "HdBe-MaritalStatus"
}, {
"uri": "https://zibs.nl/wiki/MaritalStatus-v3.1(2020EN)",
"name": "zib MaritalStatus-v3.1(2020EN)",
"identity": "zib-maritalstatus-v3.1-2020EN"
}, {
"uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-LanguageProficiency",
"name": "HdBe logical model LanguageProficiency",
"identity": "HdBe-LanguageProficiency"
}, {
"uri": "https://zibs.nl/wiki/LanguageProficiency-v3.2(2020EN)",
"name": "zib LanguageProficiency-v3.2(2020EN)",
"identity": "zib-languageproficiency-v3.2-2020EN"
}, {
"uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-ContactInformation",
"name": "HdBe logical model ContactInformation",
"identity": "HdBe-ContactInformation"
}, {
"uri": "https://zibs.nl/wiki/ContactInformation-v1.2(2020EN)",
"name": "zib ContactInformation-v1.2(2020EN)",
"identity": "zib-contactinformation-v1.2-2020EN"
}, {
"uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-ContactPerson",
"name": "HdBe logical model ContactPerson",
"identity": "HdBe-ContactPerson"
}, {
"uri": "https://zibs.nl/wiki/ContactPerson-v3.4(2020EN)",
"name": "zib ContactPerson-v3.4(2020EN)",
"identity": "zib-contactperson-v3.4-2020EN"
} ],
"abstract": false,
"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.",
"type": "Patient",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "HdBe Patient",
"package_version": "0.10.0-beta",
"status": "draft",
"id": "c9840a80-01ea-4e1a-aa9e-4124b23b7131",
"kind": "resource",
"url": "https://fhir.healthdata.be/StructureDefinition/HdBe-Patient",
"version": null,
"differential": {
"element": [ {
"id": "Patient",
"path": "Patient",
"alias": [ "Patient" ],
"short": "Patient",
"mapping": [ {
"map": "NL-CM:0.1.1",
"comment": "Patient",
"identity": "zib-patient-v3.2-2020EN"
}, {
"map": "Patient",
"identity": "HdBe-Patient"
} ]
}, {
"id": "Patient.extension",
"min": 0,
"path": "Patient.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Patient.extension:nationality",
"min": 0,
"path": "Patient.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/patient-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.",
"sliceName": "nationality"
}, {
"id": "Patient.extension:nationality.extension",
"min": 0,
"path": "Patient.extension.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Patient.extension:nationality.extension:code",
"min": 0,
"path": "Patient.extension.extension",
"sliceName": "code"
}, {
"id": "Patient.extension:nationality.extension:code.value[x]",
"path": "Patient.extension.extension.value[x]",
"alias": [ "Nationaliteit" ],
"short": "Nationality",
"binding": {
"strength": "extensible",
"valueSet": "https://fhir.healthdata.be/ValueSet/CountryISO",
"description": "Iso 3166 Part 1: 2 Letter Codes"
},
"mapping": [ {
"map": "NL-CM:7.6.3",
"comment": "Nationality",
"identity": "zib-nationality-v3.0-2020EN"
}, {
"map": "NationalityRC.Nationality",
"identity": "HdBe-Nationality"
} ],
"definition": "Indicates the country of citizenship."
}, {
"id": "Patient.identifier",
"path": "Patient.identifier",
"alias": [ "Identificatienummer" ],
"short": "PatientIdentificationNumber",
"mapping": [ {
"map": "Patient.PatientIdentificationNumber",
"identity": "HdBe-Patient"
}, {
"map": "NL-CM:0.1.7",
"comment": "PatientIdentificationNumber",
"identity": "zib-patient-v3.2-2020EN"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
},
"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."
}, {
"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",
"alias": [ "Naamgegevens" ],
"short": "NameInformation",
"mapping": [ {
"map": "NL-CM:0.1.6",
"comment": "NameInformation",
"identity": "zib-patient-v3.2-2020EN"
}, {
"map": "Patient.NameInformation",
"identity": "HdBe-Patient"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "use",
"type": "value"
} ]
},
"definition": "Patient's full name."
}, {
"id": "Patient.name:nameInformation",
"max": "2",
"path": "Patient.name",
"type": [ {
"code": "HumanName",
"profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation" ]
} ],
"sliceName": "nameInformation"
}, {
"id": "Patient.name:nameInformation-GivenName",
"path": "Patient.name",
"type": [ {
"code": "HumanName",
"profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation.GivenName" ]
} ],
"sliceName": "nameInformation-GivenName"
}, {
"id": "Patient.telecom",
"path": "Patient.telecom",
"type": [ {
"code": "ContactPoint",
"profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactInformation" ]
} ],
"alias": [ "Contactgegevens" ],
"short": "ContactInformation",
"mapping": [ {
"map": "Patient.ContactInformation",
"identity": "HdBe-Patient"
}, {
"map": "NL-CM:0.1.5",
"comment": "ContactInformation",
"identity": "zib-patient-v3.2-2020EN"
}, {
"map": "NL-CM:20.6.1",
"comment": "ContactInformation",
"identity": "zib-contactinformation-v1.2-2020EN"
} ],
"definition": "Patient’s telephone number(s) or e-mail address(es)."
}, {
"id": "Patient.gender",
"path": "Patient.gender",
"alias": [ "Geslacht" ],
"short": "Gender",
"binding": {
"strength": "required",
"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"
} ]
},
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Use ConceptMap 'GenderCodelijst-to-AdministrativeGender' to translate CBB terminology to profile terminology in ValueSet 'AdministrativeGender'"
},
"mapping": [ {
"map": "Patient.Gender",
"identity": "HdBe-Patient"
}, {
"map": "NL-CM:0.1.9",
"comment": "Gender",
"identity": "zib-patient-v3.2-2020EN"
} ],
"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."
}, {
"id": "Patient.gender.extension",
"min": 0,
"path": "Patient.gender.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Patient.gender.extension:genderCodelist",
"max": "1",
"min": 0,
"path": "Patient.gender.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification" ]
} ],
"sliceName": "genderCodelist"
}, {
"id": "Patient.gender.extension:genderCodelist.value[x]",
"path": "Patient.gender.extension.value[x]",
"alias": [ "Geslacht" ],
"short": "Gender",
"binding": {
"strength": "required",
"valueSet": "https://fhir.healthdata.be/ValueSet/Gender",
"description": "GenderCodelist"
},
"mapping": [ {
"map": "Patient.Gender",
"identity": "HdBe-Patient"
}, {
"map": "NL-CM:0.1.9",
"comment": "Gender",
"identity": "zib-patient-v3.2-2020EN"
} ],
"definition": "Patient’s administrative gender."
}, {
"id": "Patient.birthDate",
"path": "Patient.birthDate",
"alias": [ "Geboortedatum" ],
"short": "DateOfBirth",
"mapping": [ {
"map": "Patient.DateOfBirth",
"identity": "HdBe-Patient"
}, {
"map": "NL-CM:0.1.10",
"comment": "DateOfBirth",
"identity": "zib-patient-v3.2-2020EN"
} ],
"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."
}, {
"id": "Patient.deceased[x]",
"path": "Patient.deceased[x]",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"id": "Patient.deceased[x]:deceasedBoolean",
"path": "Patient.deceased[x]",
"type": [ {
"code": "boolean"
} ],
"alias": [ "OverlijdensIndicator" ],
"short": "DeathIndicator",
"mapping": [ {
"map": "Patient.DeathIndicator",
"identity": "HdBe-Patient"
}, {
"map": "NL-CM:0.1.32",
"comment": "DeathIndicator",
"identity": "zib-patient-v3.2-2020EN"
} ],
"sliceName": "deceasedBoolean",
"definition": "An indication stating whether the patient has died."
}, {
"path": "Patient.deceased[x]",
"definition": "The date on which the patient died. A ‘vague’ date, such as only the year, is permitted.",
"short": "DateOfDeath",
"mapping": [ {
"map": "Patient.DateOfDeath",
"identity": "HdBe-Patient"
}, {
"map": "Patient.DeathIndicator",
"identity": "HdBe-Patient"
}, {
"map": "NL-CM:0.1.33",
"comment": "DateOfDeath",
"identity": "zib-patient-v3.2-2020EN"
}, {
"map": "NL-CM:0.1.32",
"comment": "DeathIndicator",
"identity": "zib-patient-v3.2-2020EN"
} ],
"type": [ {
"code": "dateTime"
} ],
"sliceName": "deceasedDateTime",
"alias": [ "DatumOverlijden", "OverlijdensIndicator" ],
"id": "Patient.deceased[x]:deceasedDateTime",
"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."
}, {
"id": "Patient.address",
"path": "Patient.address",
"type": [ {
"code": "Address",
"profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-AddressInformation" ]
} ],
"mapping": [ {
"map": "Patient.AddressInformation",
"identity": "HdBe-Patient"
}, {
"map": "NL-CM:0.1.4",
"comment": "AddressInformation",
"identity": "zib-patient-v3.2-2020EN"
} ],
"definition": "Patient's address information."
}, {
"id": "Patient.maritalStatus",
"path": "Patient.maritalStatus",
"alias": [ "BurgerlijkeStaat" ],
"short": "MaritalStatus",
"binding": {
"strength": "required",
"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"
} ]
},
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MaritalStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Use ConceptMap 'BeCivilstate-to-MaritalStatus' to translate CBB terminology to profile terminology in ValueSet 'MaritalStatus'"
},
"mapping": [ {
"map": "MaritalStatusRC.MaritalStatus",
"identity": "HdBe-MaritalStatus"
}, {
"map": "NL-CM:7.9.2",
"comment": "MaritalStatus",
"identity": "zib-maritalstatus-v3.1-2020EN"
} ],
"definition": "A person’s marital status."
}, {
"id": "Patient.multipleBirth[x]",
"path": "Patient.multipleBirth[x]",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"id": "Patient.multipleBirth[x]:multipleBirthBoolean",
"path": "Patient.multipleBirth[x]",
"type": [ {
"code": "boolean"
} ],
"alias": [ "MeerlingIndicator" ],
"short": "MultipleBirthIndicator",
"mapping": [ {
"map": "Patient.MultipleBirthIndicator",
"identity": "HdBe-Patient"
}, {
"map": "NL-CM:0.1.31",
"comment": "MultipleBirthIndicator",
"identity": "zib-patient-v3.2-2020EN"
} ],
"sliceName": "multipleBirthBoolean",
"definition": "An indication stating whether the patient is of a multiple birth."
}, {
"id": "Patient.multipleBirth[x]:multipleBirthInteger",
"path": "Patient.multipleBirth[x]",
"type": [ {
"code": "integer"
} ],
"short": "MultipleBirthOrder",
"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.",
"mapping": [ {
"map": "Patient.MultipleBirthOrder",
"identity": "HdBe-Patient"
}, {
"map": "Patient.MultipleBirthIndicator",
"identity": "HdBe-Patient"
} ],
"sliceName": "multipleBirthInteger",
"definition": "An indication of the birth order in case the patient is of a multiple birth."
}, {
"id": "Patient.contact",
"path": "Patient.contact",
"alias": [ "Contactpersoon" ],
"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`.",
"mapping": [ {
"map": "NL-CM:3.1.1",
"comment": "Contact",
"identity": "zib-contactperson-v3.4-2020EN"
}, {
"map": "Contact",
"identity": "HdBe-ContactPerson"
} ]
}, {
"id": "Patient.contact.extension",
"min": 0,
"path": "Patient.contact.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Patient.contact.extension:contactPerson",
"max": "1",
"min": 0,
"path": "Patient.contact.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" ]
} ],
"sliceName": "contactPerson"
}, {
"id": "Patient.contact.extension:contactPerson.value[x]",
"path": "Patient.contact.extension.value[x]",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson" ]
} ],
"alias": [ "Contactpersoon" ],
"short": "Contact",
"mapping": [ {
"map": "NL-CM:3.1.1",
"comment": "Contact",
"identity": "zib-contactperson-v3.4-2020EN"
}, {
"map": "Contact",
"identity": "HdBe-ContactPerson"
} ],
"definition": "Reference to a [HdBe-ContactPerson](https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson) instance containing the full details for the current contact."
}, {
"id": "Patient.contact.relationship",
"path": "Patient.contact.relationship",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
}
}, {
"id": "Patient.contact.relationship:role",
"path": "Patient.contact.relationship",
"alias": [ "Rol" ],
"short": "Role",
"binding": {
"strength": "required",
"valueSet": "https://fhir.healthdata.be/ValueSet/Role",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactRelationship"
} ],
"description": "RolCodelijst"
},
"mapping": [ {
"map": "NL-CM:3.1.2",
"comment": "Role",
"identity": "zib-contactperson-v3.4-2020EN"
}, {
"map": "Role",
"identity": "HdBe-ContactPerson"
} ],
"sliceName": "role",
"definition": "Defines the role of the contact in relation to the patient."
}, {
"id": "Patient.contact.relationship:relationship",
"path": "Patient.contact.relationship",
"alias": [ "Relatie" ],
"short": "Relationship",
"binding": {
"strength": "required",
"valueSet": "https://fhir.healthdata.be/ValueSet/Relationship",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactRelationship"
} ],
"description": "RelatieCodelijst"
},
"mapping": [ {
"map": "NL-CM:3.1.3",
"comment": "Relationship",
"identity": "zib-contactperson-v3.4-2020EN"
}, {
"map": "Relationship",
"identity": "HdBe-ContactPerson"
} ],
"sliceName": "relationship",
"definition": "Defines the contact’s familial relationship to the patient."
}, {
"id": "Patient.contact.name",
"path": "Patient.contact.name",
"type": [ {
"code": "HumanName",
"profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation" ]
} ],
"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.",
"mapping": [ {
"map": "NL-CM:3.1.4",
"comment": "NameInformation",
"identity": "zib-contactperson-v3.4-2020EN"
}, {
"map": "NameInformation",
"identity": "HdBe-ContactPerson"
} ],
"definition": "Full name of the contact."
}, {
"id": "Patient.contact.telecom",
"path": "Patient.contact.telecom",
"type": [ {
"code": "ContactPoint",
"profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-ContactInformation" ]
} ],
"alias": [ "Contactgegevens" ],
"short": "ContactInformation",
"mapping": [ {
"map": "NL-CM:3.1.6",
"comment": "ContactInformation",
"identity": "zib-contactperson-v3.4-2020EN"
}, {
"map": "NL-CM:20.6.1",
"comment": "ContactInformation",
"identity": "zib-contactinformation-v1.2-2020EN"
}, {
"map": "ContactInformation",
"identity": "HdBe-ContactPerson"
} ],
"definition": "The contact’s telephone number and/or e-mail address."
}, {
"id": "Patient.contact.address",
"path": "Patient.contact.address",
"type": [ {
"code": "Address",
"profile": [ "https://fhir.healthdata.be/StructureDefinition/HdBe-AddressInformation" ]
} ],
"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.",
"mapping": [ {
"map": "NL-CM:3.1.5",
"comment": "AddressInformation",
"identity": "zib-contactperson-v3.4-2020EN"
}, {
"map": "AddressInformation",
"identity": "HdBe-ContactPerson"
} ],
"definition": "Contact’s address information."
} ]
},
"contact": [ {
"name": "Service portal – healthdata.be",
"telecom": [ {
"use": "work",
"value": "https://sciensano.service-now.com/sp",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient"
}