eHealth Platform Federal Core Profiles, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/core/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: 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.)

Usage:

• Refer to this Resource Profile: BeGroup, BeConsent, BeCommunication, BeDocumentReference and BeExtRecorder
• Examples for this Resource Profile: Patient/patient1 and Patient/patient2

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:socialGender		0..1	CodeableConcept	The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding Description (No ValueSet): (example): a value set ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:genderAtBirth		0..1	CodeableConcept	Gender at the time of birth URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth Binding: List of possible genders at birth in Belgium (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SΣC	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children be-inv-SSIN: SINN contains 11 digits without interpunction
identifier:SSIN	Σ	0..*	Identifier	An identifier for this patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	SΣ	0..*	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children
telecom	Σ	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
birthDate	Σ	0..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	BeAddress	An address for the individual ele-1: All FHIR elements must have a @value or children
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: BeCivilState (required) ele-1: All FHIR elements must have a @value or children
multipleBirth[x]		0..1		Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children
multipleBirthBoolean			boolean
multipleBirthInteger			integer
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
relationship		0..*	CodeableConcept	The kind of relationship Binding: BeContactPerson (extensible) ele-1: All FHIR elements must have a @value or children
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children
generalPractitioner		0..*	Reference(BeOrganization | BePractitioner | BePractitionerRole)	Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children
managingOrganization	Σ	0..1	Reference(BeOrganization)	Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier:SSIN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	required	BeCivilstate https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-civilstate from this IG
Patient.contact.relationship	extensible	BeContactPerson https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-contactperson from this IG
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
be-inv-SSIN	error	Patient.identifier	SINN contains 11 digits without interpunction : Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient			Patient
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:socialGender		0..1	CodeableConcept	The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding Description (No ValueSet): (example): a value set
extension:genderAtBirth		0..1	CodeableConcept	Gender at the time of birth URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth Binding: List of possible genders at birth in Belgium (required)
Slices for identifier	SC	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system be-inv-SSIN: SINN contains 11 digits without interpunction
identifier:SSIN		0..*	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
value		1..1	string	The value that is unique
name	S	0..*	HumanName	A name associated with the patient
telecom		0..*	ContactPoint	A contact detail for the individual
gender		0..1	code	male | female | other | unknown
birthDate		0..1	date	The date of birth for the individual
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not
address		0..*	BeAddress	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: BeCivilState (required)
multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth
contact		0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship		0..*	CodeableConcept	The kind of relationship Binding: BeContactPerson (extensible)
communication		0..*	BackboneElement	A 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..1	Reference(BeOrganization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.maritalStatus	required	BeCivilstate https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-civilstate from this IG
Patient.contact.relationship	extensible	BeContactPerson https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-contactperson from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
be-inv-SSIN	error	Patient.identifier	SINN contains 11 digits without interpunction : Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:socialGender		0..1	CodeableConcept	The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding Description (No ValueSet): (example): a value set
extension:genderAtBirth		0..1	CodeableConcept	Gender at the time of birth URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth Binding: List of possible genders at birth in Belgium (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system be-inv-SSIN: SINN contains 11 digits without interpunction
identifier:SSIN	Σ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description 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..1	uri	The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	0..*	HumanName	A name associated with the patient
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	BeAddress	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: BeCivilState (required)
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: BeContactPerson (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(BeOrganization | BePractitioner | BePractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(BeOrganization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier:SSIN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SSIN.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	required	BeCivilstate https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-civilstate from this IG
Patient.contact.relationship	extensible	BeContactPerson https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-contactperson from this IG
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
be-inv-SSIN	error	Patient.identifier	SINN contains 11 digits without interpunction : Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()

This structure is derived from Patient

Summary

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

Structures

This structure refers to these other structures:

• BeAddress (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-address)
• BeOrganization (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization)
• BePractitioner (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner)
• BePractitionerRole (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-nationality
• http://hl7.org/fhir/StructureDefinition/patient-birthPlace
• http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
• https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth
• http://hl7.org/fhir/StructureDefinition/patient-birthTime

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:socialGender		0..1	CodeableConcept	The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding Description (No ValueSet): (example): a value set ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:genderAtBirth		0..1	CodeableConcept	Gender at the time of birth URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth Binding: List of possible genders at birth in Belgium (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SΣC	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children be-inv-SSIN: SINN contains 11 digits without interpunction
identifier:SSIN	Σ	0..*	Identifier	An identifier for this patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	SΣ	0..*	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children
telecom	Σ	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
birthDate	Σ	0..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	BeAddress	An address for the individual ele-1: All FHIR elements must have a @value or children
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: BeCivilState (required) ele-1: All FHIR elements must have a @value or children
multipleBirth[x]		0..1		Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children
multipleBirthBoolean			boolean
multipleBirthInteger			integer
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
relationship		0..*	CodeableConcept	The kind of relationship Binding: BeContactPerson (extensible) ele-1: All FHIR elements must have a @value or children
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children
generalPractitioner		0..*	Reference(BeOrganization | BePractitioner | BePractitionerRole)	Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children
managingOrganization	Σ	0..1	Reference(BeOrganization)	Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier:SSIN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	required	BeCivilstate https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-civilstate from this IG
Patient.contact.relationship	extensible	BeContactPerson https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-contactperson from this IG
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
be-inv-SSIN	error	Patient.identifier	SINN contains 11 digits without interpunction : Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient			Patient
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:socialGender		0..1	CodeableConcept	The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding Description (No ValueSet): (example): a value set
extension:genderAtBirth		0..1	CodeableConcept	Gender at the time of birth URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth Binding: List of possible genders at birth in Belgium (required)
Slices for identifier	SC	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system be-inv-SSIN: SINN contains 11 digits without interpunction
identifier:SSIN		0..*	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
value		1..1	string	The value that is unique
name	S	0..*	HumanName	A name associated with the patient
telecom		0..*	ContactPoint	A contact detail for the individual
gender		0..1	code	male | female | other | unknown
birthDate		0..1	date	The date of birth for the individual
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not
address		0..*	BeAddress	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: BeCivilState (required)
multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth
contact		0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship		0..*	CodeableConcept	The kind of relationship Binding: BeContactPerson (extensible)
communication		0..*	BackboneElement	A 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..1	Reference(BeOrganization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.maritalStatus	required	BeCivilstate https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-civilstate from this IG
Patient.contact.relationship	extensible	BeContactPerson https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-contactperson from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
be-inv-SSIN	error	Patient.identifier	SINN contains 11 digits without interpunction : Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthPlace		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension:socialGender		0..1	CodeableConcept	The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding Description (No ValueSet): (example): a value set
extension:genderAtBirth		0..1	CodeableConcept	Gender at the time of birth URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth Binding: List of possible genders at birth in Belgium (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system be-inv-SSIN: SINN contains 11 digits without interpunction
identifier:SSIN	Σ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description 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..1	uri	The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	0..*	HumanName	A name associated with the patient
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	BeAddress	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: BeCivilState (required)
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: BeContactPerson (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(BeOrganization | BePractitioner | BePractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(BeOrganization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier:SSIN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SSIN.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.maritalStatus	required	BeCivilstate https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-civilstate from this IG
Patient.contact.relationship	extensible	BeContactPerson https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-contactperson from this IG
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
be-inv-SSIN	error	Patient.identifier	SINN contains 11 digits without interpunction : Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()

This structure is derived from Patient

Summary

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

Structures

This structure refers to these other structures:

• BeAddress (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-address)
• BeOrganization (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization)
• BePractitioner (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner)
• BePractitionerRole (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-nationality
• http://hl7.org/fhir/StructureDefinition/patient-birthPlace
• http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
• https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth
• http://hl7.org/fhir/StructureDefinition/patient-birthTime

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron