MyHealth@Eu Hospital Discharge Report
0.0.1 - qa-preview 150

MyHealth@Eu Hospital Discharge Report - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Patient: HDR

Official URL: http://fhir.ehdsi.eu/hdr/StructureDefinition/patient-hdr-myhealtheu Version: 0.0.1
Standards status: Draft Maturity Level: 1 Computable Name: PatientMyHealthEu

This profile defines how to represent Patient in FHIR for the purpose of the MyHealth@EU project.

Usage:

Formal Views of Profile Content

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient This profile also imposes the profile Patient (HDR)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... value[x] 1..1 AddressEu(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... identifier 0..* Identifier Patient identifiers.
... name C 1..* HumanNameEu(0.2.0-ci) Name of a human - parts and usage
eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present
.... Slices for extension Content/Rules for all slices
..... name-absent-reason 0..* code Reason for not providing the name.
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... 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
... gender 0..1 code The gender of the patient used for administrative purposes.
... birthDate 1..1 date The date of birth for the patient
... address 0..* AddressEu(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... contact
.... relationship 0..* CodeableConceptIPS(2.0.0) Concept - reference to a terminology or just text
.... name 0..1 HumanName Contact name
.... telecom 0..* ContactPoint Contact details for the person
.... address 0..1 AddressEu(0.2.0-ci) Contact person address
... communication
.... language 1..1 CodeableConcept Communication language
... generalPractitioner 0..* Reference(Organization (HDR) | PractitionerRole: (HDR)) Patient's nominated primary care provider.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
eu-pat-1errorPatient.namegiven, 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
This profile also imposes the profile Patient (HDR)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name C 1..* HumanNameEu(0.2.0-ci) Name of a human - parts and usage
eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present
.... Slices for extension Content/Rules for all slices
..... name-absent-reason 0..* code Reason for not providing the name.
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... 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 name: Valero Iglesias
Example spanish: Valero Iglesias
..... Slices for extension Content/Rules for all slices
...... fathersFamily 0..* string Portion of family name derived from father
URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

Example spanish name: Valero
...... mothersFamily 0..* string Portion of family name derived from mother
URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family

Example spanish name: Iglesias
.... given Σ 0..* string Given names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Example spanish name: Borja
... telecom Σ 0..* ContactPoint A contact detail for the patient
... gender Σ 0..1 code The gender of the patient used for administrative purposes.
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(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... generalPractitioner 0..* Reference(Organization (HDR) | PractitionerRole: (HDR)) Patient's nominated primary care provider.
... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
eu-pat-1errorPatient.namegiven, 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-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
This profile also imposes the profile Patient (HDR)
... 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
... 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
.... 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(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... 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..* HumanNameEu(0.2.0-ci) Name of a human - parts and usage
eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... name-absent-reason 0..* code Reason for not providing the name.
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... 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 name: Valero Iglesias
Example spanish: Valero Iglesias
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... fathersFamily 0..* string Portion of family name derived from father
URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

Example spanish name: Valero
...... mothersFamily 0..* string Portion of family name derived from mother
URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family

Example spanish name: Iglesias
..... value 0..1 string Primitive value for string
Max Length:1048576
.... given Σ 0..* string Given names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Example spanish name: Borja
.... 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 The gender of the patient used for administrative purposes.
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(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
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
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..* CodeableConceptIPS(2.0.0) Concept - reference to a terminology or just text
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName Contact name
.... telecom 0..* ContactPoint Contact details for the person
.... address 0..1 AddressEu(0.2.0-ci) 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization (HDR) | PractitionerRole: (HDR)) 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
eu-pat-1errorPatient.namegiven, 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-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient This profile also imposes the profile Patient (HDR)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... value[x] 1..1 AddressEu(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... identifier 0..* Identifier Patient identifiers.
... name C 1..* HumanNameEu(0.2.0-ci) Name of a human - parts and usage
eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present
.... Slices for extension Content/Rules for all slices
..... name-absent-reason 0..* code Reason for not providing the name.
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... 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
... gender 0..1 code The gender of the patient used for administrative purposes.
... birthDate 1..1 date The date of birth for the patient
... address 0..* AddressEu(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... contact
.... relationship 0..* CodeableConceptIPS(2.0.0) Concept - reference to a terminology or just text
.... name 0..1 HumanName Contact name
.... telecom 0..* ContactPoint Contact details for the person
.... address 0..1 AddressEu(0.2.0-ci) Contact person address
... communication
.... language 1..1 CodeableConcept Communication language
... generalPractitioner 0..* Reference(Organization (HDR) | PractitionerRole: (HDR)) Patient's nominated primary care provider.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
eu-pat-1errorPatient.namegiven, 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
This profile also imposes the profile Patient (HDR)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name C 1..* HumanNameEu(0.2.0-ci) Name of a human - parts and usage
eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present
.... Slices for extension Content/Rules for all slices
..... name-absent-reason 0..* code Reason for not providing the name.
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... 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 name: Valero Iglesias
Example spanish: Valero Iglesias
..... Slices for extension Content/Rules for all slices
...... fathersFamily 0..* string Portion of family name derived from father
URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

Example spanish name: Valero
...... mothersFamily 0..* string Portion of family name derived from mother
URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family

Example spanish name: Iglesias
.... given Σ 0..* string Given names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Example spanish name: Borja
... telecom Σ 0..* ContactPoint A contact detail for the patient
... gender Σ 0..1 code The gender of the patient used for administrative purposes.
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(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... generalPractitioner 0..* Reference(Organization (HDR) | PractitionerRole: (HDR)) Patient's nominated primary care provider.
... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
eu-pat-1errorPatient.namegiven, 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-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
This profile also imposes the profile Patient (HDR)
... 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
... 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
.... 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(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... 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..* HumanNameEu(0.2.0-ci) Name of a human - parts and usage
eu-pat-1: given, family, text or a data-absent-reason extension SHALL be present
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... name-absent-reason 0..* code Reason for not providing the name.
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... 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 name: Valero Iglesias
Example spanish: Valero Iglesias
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... fathersFamily 0..* string Portion of family name derived from father
URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

Example spanish name: Valero
...... mothersFamily 0..* string Portion of family name derived from mother
URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family

Example spanish name: Iglesias
..... value 0..1 string Primitive value for string
Max Length:1048576
.... given Σ 0..* string Given names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Example spanish name: Borja
.... 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 The gender of the patient used for administrative purposes.
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(0.2.0-ci) An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
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
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..* CodeableConceptIPS(2.0.0) Concept - reference to a terminology or just text
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName Contact name
.... telecom 0..* ContactPoint Contact details for the person
.... address 0..1 AddressEu(0.2.0-ci) 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization (HDR) | PractitionerRole: (HDR)) 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
eu-pat-1errorPatient.namegiven, 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-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

 

Other representations of profile: CSV, Excel, Schematron