HL7 Europe Laboratory Report
0.1.1 - trial-use 150

Publication Build: This will be filled in by the publication tooling

## Resource Profile: Patient: Animal

Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/Patient-animal-eu-lab | Version: 0.1.1
Standards status: Trial-use | Maturity Level: 2 | Computable Name: PatientAnimalEu
Other Identifiers: OID:2.16.840.1.113883.2.51.22.1.42.13
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

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

Usage:

- Use this Resource Profile: Bundle: Laboratory Report
- Refer to this Resource Profile: Composition: Laboratory Report, DiagnosticReport: Laboratory Report, Observation Results: laboratory, ServiceRequest: Laboratory Order and Specimen: Laboratory
- Examples for this Resource Profile: Patient/Patient-animal-example

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:patient-animal |  | 1..1 | (Complex) | This patient is known to be an animal (non-human) URL: http://hl7.org/fhir/StructureDefinition/patient-animal ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension |  | 1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:species |  | 1..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "species"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Types of species (example) ele-1: All FHIR elements must have a @value or children
extension:breed |  | 0..1 | Extension | The animal breed. E.g. Poodle, Angus. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "breed"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: AnimalBreeds (example): The breed of an animal. ele-1: All FHIR elements must have a @value or children
extension:genderStatus |  | 0..1 | Extension | The status of the animal's reproductive parts. E.g. Neutered, Intact. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "genderStatus"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: GenderStatus (example): The state of the animal's reproductive organs. ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.extension:patient-animal.extension:species.value[x] | example | LabSpeciesTypesEuVs `http://hl7.eu/fhir/laboratory/ValueSet/lab-speciesType-eu-vs` from this IG
Patient.extension:patient-animal.extension:breed.value[x] | example | AnimalBreeds `http://hl7.org/fhir/ValueSet/animal-breeds`
Patient.extension:patient-animal.extension:genderStatus.value[x] | example | GenderStatus `http://hl7.org/fhir/ValueSet/animal-genderstatus`
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

#### Constraints

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

This structure is derived from Patient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  |  | Patient |
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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 |  |  |  | Content/Rules for all slices
extension:species |  | 1..1 | Extension | Extension
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Types of species (example)
extension:recordedSexOrGender |  | 0..1 | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
telecom |  | 0..0 |  |
maritalStatus |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Patient.extension:patient-animal.extension:species.value[x] | example | LabSpeciesTypesEuVs `http://hl7.eu/fhir/laboratory/ValueSet/lab-speciesType-eu-vs` from this IG

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | 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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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 |  |
url |  | 1..1 | uri | "species"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Types of species (example)
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 |  |
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 |  |
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 | An identifier for this patient
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ | 0..* | HumanName | A name associated with the patient
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 0..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 | Σ | 0..* | Address | 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 pat-1: SHALL at least contain a contact's details or a reference to an organization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship 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 | Address | Address for the contact person
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
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.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.extension:patient-animal.extension:species.value[x] | example | LabSpeciesTypesEuVs `http://hl7.eu/fhir/laboratory/ValueSet/lab-speciesType-eu-vs` from this IG
Patient.extension:patient-animal.extension:breed.value[x] | example | AnimalBreeds `http://hl7.org/fhir/ValueSet/animal-breeds`
Patient.extension:patient-animal.extension:genderStatus.value[x] | example | GenderStatus `http://hl7.org/fhir/ValueSet/animal-genderstatus`
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` from the FHIR Standard
Patient.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship` from the FHIR Standard
Patient.contact.gender | required | AdministrativeGender `http://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
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

#### Constraints

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

This structure is derived from Patient

Summary

Mandatory: 2 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/patient-animal
- http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:patient-animal |  | 1..1 | (Complex) | This patient is known to be an animal (non-human) URL: http://hl7.org/fhir/StructureDefinition/patient-animal ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension |  | 1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:species |  | 1..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "species"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Types of species (example) ele-1: All FHIR elements must have a @value or children
extension:breed |  | 0..1 | Extension | The animal breed. E.g. Poodle, Angus. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "breed"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: AnimalBreeds (example): The breed of an animal. ele-1: All FHIR elements must have a @value or children
extension:genderStatus |  | 0..1 | Extension | The status of the animal's reproductive parts. E.g. Neutered, Intact. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "genderStatus"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: GenderStatus (example): The state of the animal's reproductive organs. ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.extension:patient-animal.extension:species.value[x] | example | LabSpeciesTypesEuVs `http://hl7.eu/fhir/laboratory/ValueSet/lab-speciesType-eu-vs` from this IG
Patient.extension:patient-animal.extension:breed.value[x] | example | AnimalBreeds `http://hl7.org/fhir/ValueSet/animal-breeds`
Patient.extension:patient-animal.extension:genderStatus.value[x] | example | GenderStatus `http://hl7.org/fhir/ValueSet/animal-genderstatus`
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

#### Constraints

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

Differential View

This structure is derived from Patient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  |  | Patient |
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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 |  |  |  | Content/Rules for all slices
extension:species |  | 1..1 | Extension | Extension
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Types of species (example)
extension:recordedSexOrGender |  | 0..1 | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
telecom |  | 0..0 |  |
maritalStatus |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Patient.extension:patient-animal.extension:species.value[x] | example | LabSpeciesTypesEuVs `http://hl7.eu/fhir/laboratory/ValueSet/lab-speciesType-eu-vs` from this IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | 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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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 |  |
url |  | 1..1 | uri | "species"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Types of species (example)
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 |  |
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 |  |
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 | An identifier for this patient
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ | 0..* | HumanName | A name associated with the patient
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 0..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 | Σ | 0..* | Address | 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 pat-1: SHALL at least contain a contact's details or a reference to an organization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship 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 | Address | Address for the contact person
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
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.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.extension:patient-animal.extension:species.value[x] | example | LabSpeciesTypesEuVs `http://hl7.eu/fhir/laboratory/ValueSet/lab-speciesType-eu-vs` from this IG
Patient.extension:patient-animal.extension:breed.value[x] | example | AnimalBreeds `http://hl7.org/fhir/ValueSet/animal-breeds`
Patient.extension:patient-animal.extension:genderStatus.value[x] | example | GenderStatus `http://hl7.org/fhir/ValueSet/animal-genderstatus`
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` from the FHIR Standard
Patient.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship` from the FHIR Standard
Patient.contact.gender | required | AdministrativeGender `http://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
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

#### Constraints

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

This structure is derived from Patient

Summary

Mandatory: 2 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/patient-animal
- http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender

Maturity: 2

Other representations of profile: CSV, Excel, Schematron