HL7 Europe Laboratory Report
0.1.0 - trial-use 150

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

Resource Profile: Patient Obligations

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:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from PatientEuLab

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientEuLabInformation about an individual or animal receiving health care services
... identifier O0..*IdentifierPatient identifiers
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... name
.... text O0..1stringText representation of the full name.
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
.... family O0..1stringFamily name
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
.... given O0..*stringGiven names. Includes middle names
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... telecom O0..*ContactPointA contact detail for the patient
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... birthDate O1..1dateThe date of birth for the individual
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... address O0..*AddressEuAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... generalPractitioner O0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated care provider
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientEuLabInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressEuAn 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
... identifier OΣ0..*IdentifierPatient identifiers
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name C1..*HumanNameEuName of a human - parts and usage
.... name-absent-reason 0..*codeReason 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..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text OΣ0..1stringText representation of the full name.
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
.... family OΣ0..1stringFamily name
Example spanish name: Valero Iglesias
Example spanish: Valero Iglesias
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
..... fathersFamily 0..*stringPortion of family name derived from father
URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

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

Example spanish name: Iglesias
.... given OΣ0..*stringGiven names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Example spanish name: Borja
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... telecom OΣ0..*ContactPointA contact detail for the patient
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... gender OΣ0..1codeAdministrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... birthDate OΣ1..1dateThe date of birth for the individual
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address OC0..*AddressEuAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... generalPractitioner O0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated care provider
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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()
pat-cnt-2or3-charwarningPatient.addressThe 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'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientEuLabInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressEuAn 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..*ExtensionExtensions that cannot be ignored
... identifier OΣ0..*IdentifierPatient identifiers
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name C1..*HumanNameEuName of a human - parts and usage
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... name-absent-reason 0..*codeReason 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..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text OΣ0..1stringText representation of the full name.
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
.... family OΣ0..1stringFamily name
Example spanish name: Valero Iglesias
Example spanish: Valero Iglesias
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... fathersFamily 0..*stringPortion of family name derived from father
URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

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

Example spanish name: Iglesias
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... given OΣ0..*stringGiven names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Example spanish name: Borja
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom OΣ0..*ContactPointA contact detail for the patient
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... gender OΣ0..1codeAdministrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... birthDate OΣ1..1dateThe date of birth for the individual
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address OC0..*AddressEuAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptIPSRelationship 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..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressEuAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner O0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated care provider
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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()
pat-cnt-2or3-charwarningPatient.addressThe 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

Summary

Maturity: 0

Differential View

This structure is derived from PatientEuLab

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientEuLabInformation about an individual or animal receiving health care services
... identifier O0..*IdentifierPatient identifiers
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... name
.... text O0..1stringText representation of the full name.
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
.... family O0..1stringFamily name
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
.... given O0..*stringGiven names. Includes middle names
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... telecom O0..*ContactPointA contact detail for the patient
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... birthDate O1..1dateThe date of birth for the individual
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... address O0..*AddressEuAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... generalPractitioner O0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated care provider
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientEuLabInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressEuAn 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
... identifier OΣ0..*IdentifierPatient identifiers
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name C1..*HumanNameEuName of a human - parts and usage
.... name-absent-reason 0..*codeReason 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..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text OΣ0..1stringText representation of the full name.
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
.... family OΣ0..1stringFamily name
Example spanish name: Valero Iglesias
Example spanish: Valero Iglesias
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
..... fathersFamily 0..*stringPortion of family name derived from father
URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

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

Example spanish name: Iglesias
.... given OΣ0..*stringGiven names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Example spanish name: Borja
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... telecom OΣ0..*ContactPointA contact detail for the patient
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... gender OΣ0..1codeAdministrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... birthDate OΣ1..1dateThe date of birth for the individual
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address OC0..*AddressEuAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... generalPractitioner O0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated care provider
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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()
pat-cnt-2or3-charwarningPatient.addressThe 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientEuLabInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressEuAn 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..*ExtensionExtensions that cannot be ignored
... identifier OΣ0..*IdentifierPatient identifiers
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name C1..*HumanNameEuName of a human - parts and usage
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... name-absent-reason 0..*codeReason 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..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text OΣ0..1stringText representation of the full name.
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
.... family OΣ0..1stringFamily name
Example spanish name: Valero Iglesias
Example spanish: Valero Iglesias
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... fathersFamily 0..*stringPortion of family name derived from father
URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

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

Example spanish name: Iglesias
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... given OΣ0..*stringGiven names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Example spanish name: Borja
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom OΣ0..*ContactPointA contact detail for the patient
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... gender OΣ0..1codeAdministrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... birthDate OΣ1..1dateThe date of birth for the individual
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address OC0..*AddressEuAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptIPSRelationship 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..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressEuAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner O0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated care provider
ObligationsActor
handleLabReportRepos
handleLabReportConsumer
sendLabReportRepos
sendLabReportCreator
populateLabReportCreator
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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()
pat-cnt-2or3-charwarningPatient.addressThe 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

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron