This page is part of the HL7 Europe Laboratory Report (v0.1.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/Patient-obl-eu-lab | Version: 0.1.0 | |||
Standards status: Informative | Maturity Level: 0 | Computable Name: PatientEuObligations | ||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
This profile defines obligations for an human Patient in FHIR for the purpose of this guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PatientEuLab
Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Patient | 0..* | PatientEuLab | Information about an individual or animal receiving health care services | |||||||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
birthPlace | 0..1 | Address | 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 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||||||||||
sex-for-clinical-use | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
identifier | OΣ | 0..* | Identifier | Patient identifiers
| ||||||||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||||||||
name | C | 1..* | HumanNameEu | Name of a human - parts and usage | ||||||||||||
name-absent-reason | 0..* | code | Reason for not providing the name URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |||||||||||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||||||
text | OΣ | 0..1 | string | Text representation of the full name.
| ||||||||||||
family | OΣ | 0..1 | string | Family name Example spanish name: Valero Iglesias Example spanish: Valero Iglesias
| ||||||||||||
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 | OΣ | 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 | OΣ | 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.
| ||||||||||||
birthDate | OΣ | 1..1 | date | The date of birth for the individual
| ||||||||||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||||||||||
deceasedBoolean | boolean | |||||||||||||||
deceasedDateTime | dateTime | |||||||||||||||
address | OC | 0..* | AddressEu | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
| ||||||||||||
generalPractitioner | O | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated 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. | ||||||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
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()) | |
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-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 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Patient | 0..* | PatientEuLab | 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.
| |||||||||||||
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 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||||||||
id | 0..1 | string | 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 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||||||||||
sex-for-clinical-use | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
identifier | OΣ | 0..* | Identifier | Patient identifiers
| ||||||||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||||||||
name | C | 1..* | HumanNameEu | Name of a human - parts and usage | ||||||||||||
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): Used to specify why the normally expected content of the data element is missing. | |||||||||||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||||||
text | OΣ | 0..1 | string | Text representation of the full name.
| ||||||||||||
family | OΣ | 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 | OΣ | 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 | OΣ | 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.
| ||||||||||||
birthDate | OΣ | 1..1 | date | The date of birth for the individual
| ||||||||||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||||||||||
deceasedBoolean | boolean | |||||||||||||||
deceasedDateTime | dateTime | |||||||||||||||
address | OC | 0..* | AddressEu | 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 | ||||||||||||
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 | Relationship between a patient and a contact person for that patient Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||||||||||
name | 0..1 | HumanName | A name associated with the contact person | |||||||||||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||||||||||
address | 0..1 | AddressEu | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||||||||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||||||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||||||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||||||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
preferred | 0..1 | boolean | Language preference indicator | |||||||||||||
generalPractitioner | O | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated 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 |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
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()) | |
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() | |
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 PatientEuLab
Differential View
This structure is derived from PatientEuLab
Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Patient | 0..* | PatientEuLab | Information about an individual or animal receiving health care services | |||||||||||||
identifier | O | 0..* | Identifier | Patient identifiers
| ||||||||||||
name | ||||||||||||||||
text | O | 0..1 | string | Text representation of the full name.
| ||||||||||||
family | O | 0..1 | string | Family name
| ||||||||||||
given | O | 0..* | string | Given names. Includes middle names
| ||||||||||||
telecom | O | 0..* | ContactPoint | A contact detail for the patient
| ||||||||||||
gender | O | 0..1 | code | Administrative Gender
| ||||||||||||
birthDate | O | 1..1 | date | The date of birth for the individual
| ||||||||||||
address | O | 0..* | AddressEu | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
| ||||||||||||
generalPractitioner | O | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated care provider
| ||||||||||||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Patient | 0..* | PatientEuLab | Information about an individual or animal receiving health care services | |||||||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
birthPlace | 0..1 | Address | 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 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||||||||||
sex-for-clinical-use | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
identifier | OΣ | 0..* | Identifier | Patient identifiers
| ||||||||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||||||||
name | C | 1..* | HumanNameEu | Name of a human - parts and usage | ||||||||||||
name-absent-reason | 0..* | code | Reason for not providing the name URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |||||||||||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||||||
text | OΣ | 0..1 | string | Text representation of the full name.
| ||||||||||||
family | OΣ | 0..1 | string | Family name Example spanish name: Valero Iglesias Example spanish: Valero Iglesias
| ||||||||||||
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 | OΣ | 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 | OΣ | 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.
| ||||||||||||
birthDate | OΣ | 1..1 | date | The date of birth for the individual
| ||||||||||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||||||||||
deceasedBoolean | boolean | |||||||||||||||
deceasedDateTime | dateTime | |||||||||||||||
address | OC | 0..* | AddressEu | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
| ||||||||||||
generalPractitioner | O | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated 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. | ||||||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
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()) | |
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-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 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Patient | 0..* | PatientEuLab | 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.
| |||||||||||||
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 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||||||||||
id | 0..1 | string | 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 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||||||||||
sex-for-clinical-use | 0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
identifier | OΣ | 0..* | Identifier | Patient identifiers
| ||||||||||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||||||||
name | C | 1..* | HumanNameEu | Name of a human - parts and usage | ||||||||||||
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): Used to specify why the normally expected content of the data element is missing. | |||||||||||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||||||
text | OΣ | 0..1 | string | Text representation of the full name.
| ||||||||||||
family | OΣ | 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 | OΣ | 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 | OΣ | 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.
| ||||||||||||
birthDate | OΣ | 1..1 | date | The date of birth for the individual
| ||||||||||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||||||||||
deceasedBoolean | boolean | |||||||||||||||
deceasedDateTime | dateTime | |||||||||||||||
address | OC | 0..* | AddressEu | 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 | ||||||||||||
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 | Relationship between a patient and a contact person for that patient Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||||||||||
name | 0..1 | HumanName | A name associated with the contact person | |||||||||||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||||||||||
address | 0..1 | AddressEu | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||||||||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||||||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||||||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||||||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
preferred | 0..1 | boolean | Language preference indicator | |||||||||||||
generalPractitioner | O | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated 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 |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
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()) | |
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() | |
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 PatientEuLab
Other representations of profile: CSV, Excel, Schematron