HL7 Belgium FHIR specifications
0.1 - QA review

This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BePatient

Belgian federal profile for a patient. Initially based on the functional description of the NIHDI. Special remarks for KMEHR users: following elements in KMEHR are not available in this FHIR resource. If needed, an extension can be defined in a future iteration of these specifications: the ‘deathlocation’ (location is not available but the death of the patient is expressed by either date or Boolean cfr. infra.), the ‘insurancystatus’ (covered in a seperate FHIR resource: Coverage), ‘insurancymembership’ (covered in a seperate FHIR resource: Coverage) and ‘profession’ (covered in a possible future FHIR resource: OccupationalData.)

The official URL for this profile is: 

https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Patient

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 2 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.identifier is sliced based on the value of value:system

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:code 0..1ExtensionExtension
..... value[x] 1..1CodeableConceptValue of extension
.... extension:period 0..1ExtensionExtension
..... value[x] 1..1PeriodValue of extension
... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... value[x] 1..1AddressValue of extension
.... identifier:SSIN 0..*IdentifierAn identifier for this patient
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value 1..1stringThe value that is unique
... name S0..*HumanNameA name associated with the patient
... telecom 0..*ContactPointA contact detail for the individual
... gender 1..1codemale | female | other | unknown
... birthDate 0..1dateThe date of birth for the individual
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patient-birthTime 0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
..... value[x] 1..1dateTimeValue of extension
... deceased[x] 0..1boolean, dateTimeIndicates if the individual is deceased or not
... address 0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: BeCivilstate (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... contact 0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
Binding: BeContactPerson (extensible)
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
... generalPractitioner 0..*Reference(BeOrganization | BePractitioner | BePractitionerRole)Patient's nominated primary care provider
... managingOrganization 0..1Reference(BeOrganization)Organization that is the custodian of the patient record

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-nationality I0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:code I0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"code"
..... value[x] I1..1CodeableConceptValue of extension
.... extension:period I0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"period"
..... value[x] I1..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... patient-birthPlace I0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] I1..1AddressValue of extension
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:SSIN ΣI0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name SΣI0..*HumanNameA name associated with the patient
... telecom ΣI0..*ContactPointA contact detail for the individual
... gender ΣI1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patient-birthTime I0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
..... value[x] I1..1dateTimeValue of extension
.... value 0..1datePrimitive value for date
... deceased[x] ?!ΣI0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address I0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: BeCivilstate (required)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship I0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name I0..1HumanNameA name associated with the contact person
.... telecom I0..*ContactPointA contact detail for the person
.... address I0..1AddressAddress for the contact person
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication I0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... preferred I0..1booleanLanguage preference indicator
... generalPractitioner I0..*Reference(BeOrganization | BePractitioner | BePractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(BeOrganization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 2 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.identifier is sliced based on the value of value:system

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:code 0..1ExtensionExtension
..... value[x] 1..1CodeableConceptValue of extension
.... extension:period 0..1ExtensionExtension
..... value[x] 1..1PeriodValue of extension
... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... value[x] 1..1AddressValue of extension
.... identifier:SSIN 0..*IdentifierAn identifier for this patient
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value 1..1stringThe value that is unique
... name S0..*HumanNameA name associated with the patient
... telecom 0..*ContactPointA contact detail for the individual
... gender 1..1codemale | female | other | unknown
... birthDate 0..1dateThe date of birth for the individual
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patient-birthTime 0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
..... value[x] 1..1dateTimeValue of extension
... deceased[x] 0..1boolean, dateTimeIndicates if the individual is deceased or not
... address 0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: BeCivilstate (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... contact 0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
Binding: BeContactPerson (extensible)
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
... generalPractitioner 0..*Reference(BeOrganization | BePractitioner | BePractitionerRole)Patient's nominated primary care provider
... managingOrganization 0..1Reference(BeOrganization)Organization that is the custodian of the patient record

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-nationality I0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:code I0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"code"
..... value[x] I1..1CodeableConceptValue of extension
.... extension:period I0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"period"
..... value[x] I1..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... patient-birthPlace I0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] I1..1AddressValue of extension
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:SSIN ΣI0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name SΣI0..*HumanNameA name associated with the patient
... telecom ΣI0..*ContactPointA contact detail for the individual
... gender ΣI1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patient-birthTime I0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
..... value[x] I1..1dateTimeValue of extension
.... value 0..1datePrimitive value for date
... deceased[x] ?!ΣI0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address I0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: BeCivilstate (required)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship I0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name I0..1HumanNameA name associated with the contact person
.... telecom I0..*ContactPointA contact detail for the person
.... address I0..1AddressAddress for the contact person
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication I0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... preferred I0..1booleanLanguage preference indicator
... generalPractitioner I0..*Reference(BeOrganization | BePractitioner | BePractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(BeOrganization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.identifier:SSIN.userequiredIdentifierUse
Patient.identifier:SSIN.typeextensibleIdentifier Type Codes
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusrequiredBeCivilstate
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.link.typerequiredLinkType

Constraints

Constraints

IdPathDetailsRequirements