MyHealth@Eu Laboratory Report
9.1.1-ci-build - trial-use 150

MyHealth@Eu Laboratory Report - Local Development build (v9.1.1-ci-build) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PatientAnimal: Laboratory

Official URL: http://fhir.ehdsi.eu/laboratory/StructureDefinition/patient-animal-myhealtheu-lab Version: 9.1.1-ci-build
Standards status: Draft Maturity Level: 1 Computable Name: PatientAnimalMyHealthLab

This profile defines how to represent an Animal as subject of care in FHIR for the purpose of this guide. This is used to identify the species when a specimen is collected from an animal

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientAnimalMyHealthCore Information about an animal receiving health care services
This profile also imposes the profile Patient: Animal
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu(2.0.0-gamma) Value of extension
.... extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... extension:patient-animal 1..1 (Complex) This patient is known to be an animal (non-human)
URL: http://hl7.org/fhir/StructureDefinition/patient-animal
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:species 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "species"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: eHDSI Animal Species With Exceptions (required)
...... extension:breed 0..1 Extension The animal breed. E.g. Poodle, Angus.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "breed"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: AnimalBreeds (example): The breed of an animal.
...... extension:genderStatus 0..1 Extension The status of the animal's reproductive parts. E.g. Neutered, Intact.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderStatus"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-animal"
.... extension:recordedSexOrGender 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... deceased[x] ?!Σ 0..1 Deceased status
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:patient-animal.​extension:species.value[x] Base required eHDSI Animal Species With Exceptions 📦1.0.0-ci-build This IG
Patient.extension:patient-animal.​extension:breed.value[x] Base example animal breeds 📦5.2.0 FHIR Extensions Pack v5.2
Patient.extension:patient-animal.​extension:genderStatus.​value[x] Base example gender status value set 📦5.2.0 FHIR Extensions Pack v5.2
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from PatientAnimalMyHealthCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientAnimalMyHealthCore Information about an animal receiving health care services
This profile also imposes the profile Patient: Animal

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientAnimalMyHealthCore Information about an animal receiving health care services
This profile also imposes the profile Patient: Animal
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu(2.0.0-gamma) Value of extension
.... extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... extension:patient-animal 1..1 (Complex) This patient is known to be an animal (non-human)
URL: http://hl7.org/fhir/StructureDefinition/patient-animal
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:species 1..1 Extension Extension
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "species"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: eHDSI Animal Species With Exceptions (required)
...... extension:breed 0..1 Extension The animal breed. E.g. Poodle, Angus.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "breed"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: AnimalBreeds (example): The breed of an animal.
...... extension:genderStatus 0..1 Extension The status of the animal's reproductive parts. E.g. Neutered, Intact.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderStatus"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-animal"
.... extension:recordedSexOrGender 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Animal identifier
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name.
.... family Σ 0..1 string Family name.
Example spanish: Valero Iglesias
.... given Σ 0..* string Given names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... gender Σ 0..1 code Administrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the patient
... deceased[x] ?!Σ 0..1 Deceased status
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* AddressEu(2.0.0-gamma) An address for the individual
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept Contact relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName Contact name
.... telecom 0..* ContactPoint Contact details for the person
.... address 0..1 AddressMyHealth Contact person address
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider.
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.extension:patient-animal.​extension:species.value[x] Base required eHDSI Animal Species With Exceptions 📦1.0.0-ci-build This IG
Patient.extension:patient-animal.​extension:breed.value[x] Base example animal breeds 📦5.2.0 FHIR Extensions Pack v5.2
Patient.extension:patient-animal.​extension:genderStatus.​value[x] Base example gender status value set 📦5.2.0 FHIR Extensions Pack v5.2
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from PatientAnimalMyHealthCore

Summary

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientAnimalMyHealthCore Information about an animal receiving health care services
This profile also imposes the profile Patient: Animal
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu(2.0.0-gamma) Value of extension
.... extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... extension:patient-animal 1..1 (Complex) This patient is known to be an animal (non-human)
URL: http://hl7.org/fhir/StructureDefinition/patient-animal
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:species 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "species"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: eHDSI Animal Species With Exceptions (required)
...... extension:breed 0..1 Extension The animal breed. E.g. Poodle, Angus.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "breed"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: AnimalBreeds (example): The breed of an animal.
...... extension:genderStatus 0..1 Extension The status of the animal's reproductive parts. E.g. Neutered, Intact.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderStatus"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-animal"
.... extension:recordedSexOrGender 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... deceased[x] ?!Σ 0..1 Deceased status
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:patient-animal.​extension:species.value[x] Base required eHDSI Animal Species With Exceptions 📦1.0.0-ci-build This IG
Patient.extension:patient-animal.​extension:breed.value[x] Base example animal breeds 📦5.2.0 FHIR Extensions Pack v5.2
Patient.extension:patient-animal.​extension:genderStatus.​value[x] Base example gender status value set 📦5.2.0 FHIR Extensions Pack v5.2
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from PatientAnimalMyHealthCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientAnimalMyHealthCore Information about an animal receiving health care services
This profile also imposes the profile Patient: Animal

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientAnimalMyHealthCore Information about an animal receiving health care services
This profile also imposes the profile Patient: Animal
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu(2.0.0-gamma) Value of extension
.... extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... extension:patient-animal 1..1 (Complex) This patient is known to be an animal (non-human)
URL: http://hl7.org/fhir/StructureDefinition/patient-animal
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:species 1..1 Extension Extension
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "species"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: eHDSI Animal Species With Exceptions (required)
...... extension:breed 0..1 Extension The animal breed. E.g. Poodle, Angus.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "breed"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: AnimalBreeds (example): The breed of an animal.
...... extension:genderStatus 0..1 Extension The status of the animal's reproductive parts. E.g. Neutered, Intact.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderStatus"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-animal"
.... extension:recordedSexOrGender 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Animal identifier
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name.
.... family Σ 0..1 string Family name.
Example spanish: Valero Iglesias
.... given Σ 0..* string Given names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... gender Σ 0..1 code Administrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the patient
... deceased[x] ?!Σ 0..1 Deceased status
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* AddressEu(2.0.0-gamma) An address for the individual
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept Contact relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName Contact name
.... telecom 0..* ContactPoint Contact details for the person
.... address 0..1 AddressMyHealth Contact person address
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider.
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.extension:patient-animal.​extension:species.value[x] Base required eHDSI Animal Species With Exceptions 📦1.0.0-ci-build This IG
Patient.extension:patient-animal.​extension:breed.value[x] Base example animal breeds 📦5.2.0 FHIR Extensions Pack v5.2
Patient.extension:patient-animal.​extension:genderStatus.​value[x] Base example gender status value set 📦5.2.0 FHIR Extensions Pack v5.2
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from PatientAnimalMyHealthCore

Summary

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron