HL7 Europe Base and Core FHIR IG
0.1.0-snapshot - draft 150

HL7 Europe Base and Core FHIR IG - Local Development build (v0.1.0-snapshot) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: Patient (EU core)

Official URL: http://hl7.eu/fhir/base-r5/StructureDefinition/patient-eu-core | Version: 0.1.0-snapshot
Standards status: Draft | Maturity Level: 2 | Computable Name: PatientEuCore
Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile sets minimum expectations for the Patient resource common to most of the use cases. When the ips-pat-1 invariant is satisfied (Patient.name.given, Patient.name.family or Patient.name.text SHALL be present) then this profile complies with the IPS patient profile.

Usages:

- Examples for this Profile: Patient/patient-eu-core-example

You can also check for usages in the FHIR IG Statistics

### 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 Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | PatientEu | Information about an individual or animal receiving health care services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  |  |  | Content/Rules for all slices
extension:birthPlace |  | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x] |  | 1..1 | AddressEu | Value of extension
extension:sex-for-clinical-use |  | 0..* | (Complex) | Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:gender-identity |  | 0..* | (Complex) | Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:pronouns |  | 0..* | (Complex) | Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:patient-citizenship |  | 0..* | (Complex) | Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
extension:patient-nationality |  | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthTime |  | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
birthDate | Σ | 1..1 | date | The date of birth for the patient
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual
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, or Patient/RelatedPerson when using the seealso code
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|5.0.0` From the FHIR Standard
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|5.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
eu-pat-1 | error | Patient.name | given, family, text or a data-absent-reason extension SHALL be present : family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from PatientEu

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | PatientEu | Information about an individual or animal receiving health care services
name | C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
birthDate |  | 1..1 | date | The date of birth for the patient
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
eu-pat-1 | error | Patient.name | given, family, text or a data-absent-reason extension SHALL be present : family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | PatientEu | 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: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:birthPlace |  | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x] |  | 1..1 | AddressEu | Value of extension
extension:sex-for-clinical-use |  | 0..* | (Complex) | Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:gender-identity |  | 0..* | (Complex) | Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:pronouns |  | 0..* | (Complex) | Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:patient-citizenship |  | 0..* | (Complex) | Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
extension:patient-nationality |  | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthTime |  | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Patient identifiers
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
id |  | 0..1 | id | 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name.
family | Σ | 0..1 | string | Family name. Example spanish: Valero Iglesias
given | Σ | 0..* | string | Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | Σ | 0..* | ContactPoint | A contact detail for the patient
gender | Σ | 0..1 | code | Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 1..1 | date | The date of birth for the patient
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | Σ | 0..* | AddressEu | An address for the individual
maritalStatus |  | 0..1 | CodeableConcept | Marital status Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
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 Constraints: pat-1
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 | Contact relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name | C | 0..1 | HumanName | Contact name
telecom | C | 0..* | ContactPoint | Contact details for the person
address | C | 0..1 | AddressEu | Contact person address
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 | Communication language Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization (EU base) | PractitionerRole (EU base) | Practitioner (EU base)) | Patient's nominated primary care provider.
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual
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, or Patient/RelatedPerson when using the seealso code
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.language | required | AllLanguages `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` From the FHIR Standard
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|5.0.0` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0` From the FHIR Standard
Patient.maritalStatus | extensible | MaritalStatusCodes `http://hl7.org/fhir/ValueSet/marital-status|5.0.0` From the FHIR Standard
Patient.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship|5.0.0` From the FHIR Standard
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0` From the FHIR Standard
Patient.communication.language | required | AllLanguages `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` From the FHIR Standard
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|5.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
eu-pat-1 | error | Patient.name | given, family, text or a data-absent-reason extension SHALL be present : family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |

This structure is derived from PatientEu

Summary

Mandatory: 2 elements

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | PatientEu | Information about an individual or animal receiving health care services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  |  |  | Content/Rules for all slices
extension:birthPlace |  | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x] |  | 1..1 | AddressEu | Value of extension
extension:sex-for-clinical-use |  | 0..* | (Complex) | Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:gender-identity |  | 0..* | (Complex) | Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:pronouns |  | 0..* | (Complex) | Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:patient-citizenship |  | 0..* | (Complex) | Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
extension:patient-nationality |  | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthTime |  | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
birthDate | Σ | 1..1 | date | The date of birth for the patient
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual
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, or Patient/RelatedPerson when using the seealso code
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|5.0.0` From the FHIR Standard
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|5.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
eu-pat-1 | error | Patient.name | given, family, text or a data-absent-reason extension SHALL be present : family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Differential View

This structure is derived from PatientEu

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | PatientEu | Information about an individual or animal receiving health care services
name | C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
birthDate |  | 1..1 | date | The date of birth for the patient
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
eu-pat-1 | error | Patient.name | given, family, text or a data-absent-reason extension SHALL be present : family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | PatientEu | 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: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:birthPlace |  | 0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x] |  | 1..1 | AddressEu | Value of extension
extension:sex-for-clinical-use |  | 0..* | (Complex) | Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:gender-identity |  | 0..* | (Complex) | Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:pronouns |  | 0..* | (Complex) | Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:patient-citizenship |  | 0..* | (Complex) | Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
extension:patient-nationality |  | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthTime |  | 0..1 | dateTime | Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Patient identifiers
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
id |  | 0..1 | id | 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name.
family | Σ | 0..1 | string | Family name. Example spanish: Valero Iglesias
given | Σ | 0..* | string | Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | Σ | 0..* | ContactPoint | A contact detail for the patient
gender | Σ | 0..1 | code | Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 1..1 | date | The date of birth for the patient
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | Σ | 0..* | AddressEu | An address for the individual
maritalStatus |  | 0..1 | CodeableConcept | Marital status Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
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 Constraints: pat-1
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 | Contact relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name | C | 0..1 | HumanName | Contact name
telecom | C | 0..* | ContactPoint | Contact details for the person
address | C | 0..1 | AddressEu | Contact person address
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 | Communication language Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization (EU base) | PractitionerRole (EU base) | Practitioner (EU base)) | Patient's nominated primary care provider.
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual
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, or Patient/RelatedPerson when using the seealso code
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.language | required | AllLanguages `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` From the FHIR Standard
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|5.0.0` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0` From the FHIR Standard
Patient.maritalStatus | extensible | MaritalStatusCodes `http://hl7.org/fhir/ValueSet/marital-status|5.0.0` From the FHIR Standard
Patient.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship|5.0.0` From the FHIR Standard
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0` From the FHIR Standard
Patient.communication.language | required | AllLanguages `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` From the FHIR Standard
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|5.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
eu-pat-1 | error | Patient.name | given, family, text or a data-absent-reason extension SHALL be present : family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |

This structure is derived from PatientEu

Summary

Mandatory: 2 elements

Maturity: 2

Other representations of profile: CSV, Excel, Schematron