HL7 Europe Laboratory Report
2.0.0 - ci-build 150

HL7 Europe Laboratory Report - Downloaded Version 2.0.0 See the Directory of published versions

## Resource Profile: RelatedPerson: AnimalSpecimen

Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/animal-specimen-eu-lab | Version: 2.0.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: AnimalSpecimenEuLab
Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile defines how to represent an Animal as source of a specimen or focus of the observation in FHIR for the purpose of this guide. This is used to identify the species when a specimen is collected from an animal and observation made on this specimen. It can also be used to identify the species when an observation is focused directly on the animal, without a specimen being collected.

Usages:

- Refer to this Profile: Observation Results: laboratory and Specimen: Laboratory
- Examples for this Profile: RelatedPerson/RelatedPerson-animal-example

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.

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
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:specimen-animal |  | 1..1 | (Complex) | The Species of the Service Animal URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use
patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to
name | Σ | 0..* | HumanName | The name of the animal
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
RelatedPerson.extension:specimen-animal.​value[x] | Base | example | Types of species | 📦2.0.0 | This IG
RelatedPerson.communication.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | RelatedPerson | 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 RelatedPerson

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:specimen-animal |  | 1..1 | (Complex) | The Species of the Service Animal URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
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
relationship |  | 0..0 |  | The nature of the relationship
name |  | 0..* | HumanName | The name of the animal
telecom |  | 0..0 |  | A contact detail for the person
gender |  | 0..0 |  | male | female | other | unknown
address |  | 0..0 |  | Address where the related person can be contacted or visited
photo |  | 0..0 |  | Image of the person
period |  | 0..0 |  | Period of time that this relationship is considered valid
communication |  | 0..0 |  | A language which may be used to communicate with about the patient's health
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
RelatedPerson.extension:specimen-animal.​value[x] | Base | example | Types of species | 📦2.0.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
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 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:specimen-animal |  | 1..1 | (Complex) | The Species of the Service Animal URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
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/practitioner-animalSpecies"
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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | A human identifier for this person
active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use
patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to
name | Σ | 0..* | HumanName | The name of the animal
birthDate | Σ | 0..1 | date | The date on which the related person was born
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
RelatedPerson.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
RelatedPerson.extension:specimen-animal.​value[x] | Base | example | Types of species | 📦2.0.0 | This IG
RelatedPerson.communication.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | RelatedPerson | 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 RelatedPerson

Summary

Mandatory: 2 elements
Prohibited: 7 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies|5.2.0
- http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
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:specimen-animal |  | 1..1 | (Complex) | The Species of the Service Animal URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use
patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to
name | Σ | 0..* | HumanName | The name of the animal
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
RelatedPerson.extension:specimen-animal.​value[x] | Base | example | Types of species | 📦2.0.0 | This IG
RelatedPerson.communication.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | RelatedPerson | 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 RelatedPerson

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:specimen-animal |  | 1..1 | (Complex) | The Species of the Service Animal URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
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
relationship |  | 0..0 |  | The nature of the relationship
name |  | 0..* | HumanName | The name of the animal
telecom |  | 0..0 |  | A contact detail for the person
gender |  | 0..0 |  | male | female | other | unknown
address |  | 0..0 |  | Address where the related person can be contacted or visited
photo |  | 0..0 |  | Image of the person
period |  | 0..0 |  | Period of time that this relationship is considered valid
communication |  | 0..0 |  | A language which may be used to communicate with about the patient's health
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
RelatedPerson.extension:specimen-animal.​value[x] | Base | example | Types of species | 📦2.0.0 | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
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 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:specimen-animal |  | 1..1 | (Complex) | The Species of the Service Animal URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
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/practitioner-animalSpecies"
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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | A human identifier for this person
active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use
patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to
name | Σ | 0..* | HumanName | The name of the animal
birthDate | Σ | 0..1 | date | The date on which the related person was born
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
RelatedPerson.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
RelatedPerson.extension:specimen-animal.​value[x] | Base | example | Types of species | 📦2.0.0 | This IG
RelatedPerson.communication.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | RelatedPerson | 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 RelatedPerson

Summary

Mandatory: 2 elements
Prohibited: 7 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies|5.2.0
- http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender

Maturity: 2

Other representations of profile: CSV, Excel, Schematron