WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
This is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc and changes regularly.
Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-pre-uv-ips | Version: 1.0.0 | |||
Active as of 2021-10-04 | Computable Name: PatientUvIps |
This profile represents the constraints applied to the Patient resource by the International Patient Summary (IPS) FHIR Implementation Guide and describes the minimum expectations for the Patient resource when used in the IPS composition or in one of the referred resources.
This profile has been temporary added to this Implementation Guide, to allow the pre-adoption of some changes not yet officially published.
This profile is not an official IPS profile and it will be removed as soon as the next HL7 FHIR IPS release will be published.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | S | 0..* | Patient | Information about an individual or animal receiving health care services |
![]() ![]() ![]() | S | 0..* | Identifier | An identifier for this patient |
![]() ![]() ![]() | S | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | S | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() | S | 0..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | S | 0..* | string | Given names (not always 'first'). Includes middle names |
![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() | S | 0..1 | code | male | female | other | unknown |
![]() ![]() ![]() | S | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() | SC | 0..* | Address | An address for the individual pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. |
![]() ![]() ![]() | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() ![]() | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Personal Relationship - IPS [Deprecated] (required) |
![]() ![]() ![]() ![]() | S | 0..1 | HumanName | A name associated with the contact person |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | S | 0..1 | Address | Address for the contact person |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(Organization) | Organization that is associated with the contact |
![]() ![]() ![]() | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required) |
![]() ![]() ![]() | S | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
![]() |
Path | Conformance | ValueSet |
Patient.contact.relationship | required | PersonalRelationshipUvIps |
Patient.communication.language | required | AllLanguages |
Id | Grade | Path(s) | Details | Requirements |
pat-cnt-2or3-char | warning | Patient.address | The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. : country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | S | 0..* | Patient | Information about an individual or animal receiving health care services |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣ | 0..* | Identifier | An identifier for this patient |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | SΣ | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | SΣ | 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 |
![]() ![]() ![]() | SΣ | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() | SΣ | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | SΣC | 0..* | Address | An address for the individual pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. |
![]() ![]() ![]() | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Personal Relationship - IPS [Deprecated] (required) |
![]() ![]() ![]() ![]() | S | 0..1 | HumanName | A name associated with the contact person |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | S | 0..1 | Address | Address for the contact person |
![]() ![]() ![]() ![]() | SC | 0..1 | Reference(Organization) | Organization that is associated with the contact |
![]() ![]() ![]() | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required) |
![]() ![]() ![]() | S | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
![]() |
Path | Conformance | ValueSet |
Patient.name.use | required | NameUse |
Patient.gender | required | AdministrativeGender |
Patient.contact.relationship | required | PersonalRelationshipUvIps |
Patient.communication.language | required | AllLanguages |
Patient.link.type | required | LinkType |
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().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()) | |
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() | |
pat-cnt-2or3-char | warning | Patient.address | The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. : country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | S | 0..* | Patient | Information about an individual or animal receiving health care services | ||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | SΣ | 0..* | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() | SΣ | 1..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() | SΣ | 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 | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() | SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() | SΣ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() | SΣC | 0..* | Address | An address for the individual pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | integer | |||||||
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Personal Relationship - IPS [Deprecated] (required) | ||||
![]() ![]() ![]() ![]() | S | 0..1 | HumanName | A name associated with the contact person | ||||
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() | S | 0..1 | Address | Address for the contact person | ||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() | SC | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required) | ||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() | S | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.name.use | required | NameUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.maritalStatus | extensible | Marital Status Codes | ||||
Patient.contact.relationship | required | PersonalRelationshipUvIps | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | required | AllLanguages | ||||
Patient.link.type | required | LinkType |
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().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()) | |
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() | |
pat-cnt-2or3-char | warning | Patient.address | The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. : country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
This structure is derived from Patient
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | S | 0..* | Patient | Information about an individual or animal receiving health care services |
![]() ![]() ![]() | S | 0..* | Identifier | An identifier for this patient |
![]() ![]() ![]() | S | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | S | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() | S | 0..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | S | 0..* | string | Given names (not always 'first'). Includes middle names |
![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() | S | 0..1 | code | male | female | other | unknown |
![]() ![]() ![]() | S | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() | SC | 0..* | Address | An address for the individual pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. |
![]() ![]() ![]() | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() ![]() | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Personal Relationship - IPS [Deprecated] (required) |
![]() ![]() ![]() ![]() | S | 0..1 | HumanName | A name associated with the contact person |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | S | 0..1 | Address | Address for the contact person |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(Organization) | Organization that is associated with the contact |
![]() ![]() ![]() | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required) |
![]() ![]() ![]() | S | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
![]() |
Path | Conformance | ValueSet |
Patient.contact.relationship | required | PersonalRelationshipUvIps |
Patient.communication.language | required | AllLanguages |
Id | Grade | Path(s) | Details | Requirements |
pat-cnt-2or3-char | warning | Patient.address | The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. : country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | S | 0..* | Patient | Information about an individual or animal receiving health care services |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣ | 0..* | Identifier | An identifier for this patient |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | SΣ | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | SΣ | 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 |
![]() ![]() ![]() | SΣ | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() | SΣ | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | SΣC | 0..* | Address | An address for the individual pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. |
![]() ![]() ![]() | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Personal Relationship - IPS [Deprecated] (required) |
![]() ![]() ![]() ![]() | S | 0..1 | HumanName | A name associated with the contact person |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | S | 0..1 | Address | Address for the contact person |
![]() ![]() ![]() ![]() | SC | 0..1 | Reference(Organization) | Organization that is associated with the contact |
![]() ![]() ![]() | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required) |
![]() ![]() ![]() | S | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
![]() |
Path | Conformance | ValueSet |
Patient.name.use | required | NameUse |
Patient.gender | required | AdministrativeGender |
Patient.contact.relationship | required | PersonalRelationshipUvIps |
Patient.communication.language | required | AllLanguages |
Patient.link.type | required | LinkType |
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().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()) | |
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() | |
pat-cnt-2or3-char | warning | Patient.address | The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. : country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | S | 0..* | Patient | Information about an individual or animal receiving health care services | ||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | SΣ | 0..* | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() | SΣ | 1..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() | SΣ | 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 | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() | SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() | SΣ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() | SΣC | 0..* | Address | An address for the individual pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | integer | |||||||
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Personal Relationship - IPS [Deprecated] (required) | ||||
![]() ![]() ![]() ![]() | S | 0..1 | HumanName | A name associated with the contact person | ||||
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() | S | 0..1 | Address | Address for the contact person | ||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() | SC | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required) | ||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() | S | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.name.use | required | NameUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.maritalStatus | extensible | Marital Status Codes | ||||
Patient.contact.relationship | required | PersonalRelationshipUvIps | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | required | AllLanguages | ||||
Patient.link.type | required | LinkType |
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().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()) | |
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() | |
pat-cnt-2or3-char | warning | Patient.address | The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. : country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
This structure is derived from Patient
Other representations of profile: CSV, Excel, Schematron