MyHealth@EU Core
1.0.0 - trial-use 150

MyHealth@EU Core - Downloaded Version 1.0.0 See the Directory of published versions

## Resource Profile: Patient (Core)

Official URL: http://fhir.ehdsi.eu/core/StructureDefinition/patient-myhealtheu-core | Version: 1.0.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: PatientMyHealthCore

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:

- Refer to this Profile: Allergy Intolerance (Core), BodyStructure (Core), Composition (Core), Condition (Core)... Show 7 more, DiagnosticReport (Core), Flag (Core), Immunization (Core), Observation: Medical Test Result (Core), MedicationRequest (Core), MedicationStatement (Core) and Procedure (Core)
- Examples for this Profile: Patient/1d4bbc93-63b7-4f2b-8f0f-8380aa138f49

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..* | PatientEuCore | Information about an individual or animal receiving health care services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
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 |  | Extension Slice: Unordered, Open by value:url
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
extension:nationality |  | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Slices for extension |  |  |  | Content/Rules for all slices
extension:code |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: eHDSI Country (required)
extension:period |  | 0..1 | Extension | Nationality Period
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "period"
value[x] |  | 1..1 | Period | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | O Σ | 0..* | Identifier | Patient identifiers
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | O Σ C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
gender | O Σ | 0..1 | code | Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
birthDate | O Σ | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | Σ | 0..* | AddressMyHealth | An address for the individual
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
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 | Status | Usage | ValueSet | Version | Source
Patient.extension:nationality.​extension:code.value[x] | Base | required | eHDSI Country | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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 PatientEuCore

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | PatientEuCore | Information about an individual or animal receiving health care services
Slices for extension |  |  |  | Content/Rules for all slices
extension:nationality |  | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Slices for extension |  |  |  | Content/Rules for all slices
extension:code |  | 0..1 | Extension | Extension
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: eHDSI Country (required)
identifier | O | 0..* | Identifier | Patient identifiers
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
name | O C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
gender | O | 0..1 | code | Administrative Gender
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
birthDate | O | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
address |  | 0..* | AddressMyHealth | An address for the individual
contact |  |  |  |
relationship |  | 0..* | CodeableConcept | Contact relationship Binding: eHDSI Personal Relationship (extensible)
address |  | 0..1 | AddressMyHealth | Contact person address
communication |  |  |  |
language |  | 1..1 | CodeableConcept | Communication language Binding: eHDSI Language (required)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.extension:nationality.​extension:code.value[x] | Base | required | eHDSI Country | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.contact.relationship | Base | extensible | eHDSI Personal Relationship | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.communication.​language | Base | required | eHDSI Language | 📦9.1.0 | MyHealthEu MVC package v9.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
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..* | PatientEuCore | 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 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 |  | Extension Slice: Unordered, Open by value:url
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
extension:nationality |  | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
id |  | 0..1 | id | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code |  | 0..1 | Extension | Extension
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: eHDSI Country (required)
extension:period |  | 0..1 | Extension | Nationality Period
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "period"
value[x] |  | 1..1 | Period | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | O Σ | 0..* | Identifier | Patient identifiers
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | O Σ C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
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 | 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 (not always 'first'). 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 | O Σ | 0..1 | code | Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
birthDate | O Σ | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | Σ | 0..* | AddressMyHealth | An address for the individual
maritalStatus |  | 0..1 | CodeableConcept | Marital status Binding: Marital Status Codes (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: eHDSI Personal Relationship (extensible)
name |  | 0..1 | HumanName | Contact name
telecom |  | 0..* | ContactPoint | Contact details for the person
address |  | 0..1 | AddressMyHealth | 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: eHDSI Language (required)
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | 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 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 | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Patient.extension:nationality.​extension:code.value[x] | Base | required | eHDSI Country | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | eHDSI Personal Relationship | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | required | eHDSI Language | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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 PatientEuCore

Summary

Structures

This structure refers to these other structures:

- Address (MyHealth@EU) (http://fhir.ehdsi.eu/core/StructureDefinition/Address-myhealth)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/patient-nationality|5.2.0

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | PatientEuCore | Information about an individual or animal receiving health care services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
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 |  | Extension Slice: Unordered, Open by value:url
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
extension:nationality |  | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Slices for extension |  |  |  | Content/Rules for all slices
extension:code |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: eHDSI Country (required)
extension:period |  | 0..1 | Extension | Nationality Period
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "period"
value[x] |  | 1..1 | Period | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | O Σ | 0..* | Identifier | Patient identifiers
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | O Σ C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
gender | O Σ | 0..1 | code | Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
birthDate | O Σ | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | Σ | 0..* | AddressMyHealth | An address for the individual
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
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 | Status | Usage | ValueSet | Version | Source
Patient.extension:nationality.​extension:code.value[x] | Base | required | eHDSI Country | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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 PatientEuCore

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | PatientEuCore | Information about an individual or animal receiving health care services
Slices for extension |  |  |  | Content/Rules for all slices
extension:nationality |  | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Slices for extension |  |  |  | Content/Rules for all slices
extension:code |  | 0..1 | Extension | Extension
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: eHDSI Country (required)
identifier | O | 0..* | Identifier | Patient identifiers
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
name | O C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
gender | O | 0..1 | code | Administrative Gender
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
birthDate | O | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
address |  | 0..* | AddressMyHealth | An address for the individual
contact |  |  |  |
relationship |  | 0..* | CodeableConcept | Contact relationship Binding: eHDSI Personal Relationship (extensible)
address |  | 0..1 | AddressMyHealth | Contact person address
communication |  |  |  |
language |  | 1..1 | CodeableConcept | Communication language Binding: eHDSI Language (required)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.extension:nationality.​extension:code.value[x] | Base | required | eHDSI Country | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.contact.relationship | Base | extensible | eHDSI Personal Relationship | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.communication.​language | Base | required | eHDSI Language | 📦9.1.0 | MyHealthEu MVC package v9.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
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..* | PatientEuCore | 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 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 |  | Extension Slice: Unordered, Open by value:url
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
extension:nationality |  | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
id |  | 0..1 | id | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code |  | 0..1 | Extension | Extension
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: eHDSI Country (required)
extension:period |  | 0..1 | Extension | Nationality Period
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "period"
value[x] |  | 1..1 | Period | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | O Σ | 0..* | Identifier | Patient identifiers
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | O Σ C | 1..* | HumanName | A name associated with the patient Constraints: eu-pat-1
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
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 | 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 (not always 'first'). 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 | O Σ | 0..1 | code | Administrative Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Obligations | Actor
SHOULD:handle | MyHealth@EU Handler
birthDate | O Σ | 1..1 | date | The date of birth for the individual
Obligations | Actor
SHALL:handle | MyHealth@EU Handler
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | Σ | 0..* | AddressMyHealth | An address for the individual
maritalStatus |  | 0..1 | CodeableConcept | Marital status Binding: Marital Status Codes (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: eHDSI Personal Relationship (extensible)
name |  | 0..1 | HumanName | Contact name
telecom |  | 0..* | ContactPoint | Contact details for the person
address |  | 0..1 | AddressMyHealth | 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: eHDSI Language (required)
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | 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 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 | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Patient.extension:nationality.​extension:code.value[x] | Base | required | eHDSI Country | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | eHDSI Personal Relationship | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | required | eHDSI Language | 📦9.1.0 | MyHealthEu MVC package v9.1
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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 PatientEuCore

Summary

Structures

This structure refers to these other structures:

- Address (MyHealth@EU) (http://fhir.ehdsi.eu/core/StructureDefinition/Address-myhealth)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/patient-nationality|5.2.0

Maturity: 2

Other representations of profile: CSV, Excel, Schematron