This is an old version - please visit our new IG location
1.1.0 - published

This is an old version - please visit <a href='https://simplifier.net/guide/ImplementationGuideTheCoreBelgianFederalFHIRProfiles/Home'>our new IG location</a> - Local Development build (v1.1.0). See the Directory of published versions

Resource Profile: Patient core BE profile

Defining URL:https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient
Version:1.0.0
Name:BePatient
Title:Patient core BE profile
Status:Active as of 2021-05-26T14:31:36+02:00
Definition:

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.)

Publisher:eHealth Platform
Source Resource:XML / JSON / Turtle

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 (4 nested mandatory elements)
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
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... extension:period 0..1ExtensionExtension
..... valuePeriod 1..1PeriodValue of extension
... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... valueAddress 0..1AddressValue of extension
.... identifier:SSIN S0..*IdentifierAn identifier for this patient
..... system 1..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
..... valueDateTime 0..1dateTimeValue of extension
... deceased[x] 0..1booleanIndicates 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: ValueSet civil state (required)
... multipleBirth[x] 0..1booleanWhether patient is part of a multiple birth
... contact 0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: ValueSet contact person (extensible)
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
... generalPractitioner 0..*Reference(Organization core BE profile | Practitioner core BE profile | Practitioner Role core BE profile)Patient's nominated primary care provider
... managingOrganization 0..1Reference(Organization core BE profile)Organization that is the custodian of the patient record

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:code 0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"code"
..... value[x] 1..1CodeableConceptValue of extension
.... extension:period 0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"period"
..... value[x] 1..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueAddress 0..1AddressValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:SSIN SΣ0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
..... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueDateTime 0..1dateTimeValue of extension
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1booleanIndicates 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: ValueSet civil state (required)
... multipleBirth[x] 0..1booleanWhether patient is part of a multiple birth
... photo 0..*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 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: ValueSet contact person (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*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 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization core BE profile | Practitioner core BE profile | Practitioner Role core BE profile)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization core BE profile)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... identifier:SSIN Σ0..*IdentifierAn identifier for this patient
... name Σ0..*HumanNameA name associated with the patient

doco Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 1 element (4 nested mandatory elements)
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
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... extension:period 0..1ExtensionExtension
..... valuePeriod 1..1PeriodValue of extension
... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... valueAddress 0..1AddressValue of extension
.... identifier:SSIN S0..*IdentifierAn identifier for this patient
..... system 1..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
..... valueDateTime 0..1dateTimeValue of extension
... deceased[x] 0..1booleanIndicates 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: ValueSet civil state (required)
... multipleBirth[x] 0..1booleanWhether patient is part of a multiple birth
... contact 0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: ValueSet contact person (extensible)
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
... generalPractitioner 0..*Reference(Organization core BE profile | Practitioner core BE profile | Practitioner Role core BE profile)Patient's nominated primary care provider
... managingOrganization 0..1Reference(Organization core BE profile)Organization that is the custodian of the patient record

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:code 0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"code"
..... value[x] 1..1CodeableConceptValue of extension
.... extension:period 0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"period"
..... value[x] 1..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueAddress 0..1AddressValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:SSIN SΣ0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
..... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueDateTime 0..1dateTimeValue of extension
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1booleanIndicates 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: ValueSet civil state (required)
... multipleBirth[x] 0..1booleanWhether patient is part of a multiple birth
... photo 0..*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 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: ValueSet contact person (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*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 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization core BE profile | Practitioner core BE profile | Practitioner Role core BE profile)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization core BE profile)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

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