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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: RelatedPerson: Animal specimen source

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: ObservationResults: Laboratory and Specimen: Laboratory
• Examples for this Profile: RelatedPerson/SampleAnimalSpecimen

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..*	AnimalSpecimenEuLab	A person that is related to a patient, but who is not a direct target of care
RelatedPerson.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
RelatedPerson.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension:specimen-animal		1..1	(Complex)	The Species of the Service Animal URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
RelatedPerson.Slices for extension.extension:specimen-animal.extension		0..0		Extension Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension:specimen-animal.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
RelatedPerson.Slices for extension.extension:specimen-animal.value[x]		1..1	CodeableConcept	Value of extension Binding: eHDSI Animal Species With Exceptions (required)
RelatedPerson.Slices for extension.extension:recordedSexOrGender		0..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this related person's record is in active use
RelatedPerson.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient this person is related to
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.extension:specimen-animal.​value[x]	Base	required	eHDSI Animal Species With Exceptions	📦1.0.1	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 AnimalSpecimenEuLab

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	AnimalSpecimenEuLab	A person that is related to a patient, but who is not a direct target of care
RelatedPerson.Slices for extension				Content/Rules for all slices
RelatedPerson.Slices for extension.extension:specimen-animal		1..1	PRAnimalSpecies(5.3.0)	The Species of the Service Animal
RelatedPerson.Slices for extension.extension:specimen-animal.value[x]		1..1	CodeableConcept	Value of extension Binding: eHDSI Animal Species With Exceptions (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.extension:specimen-animal.​value[x]	Base	required	eHDSI Animal Species With Exceptions	📦1.0.1	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	AnimalSpecimenEuLab	A person that is related to a patient, but who is not a direct target of care
RelatedPerson.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
RelatedPerson.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
RelatedPerson.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
RelatedPerson.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.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
RelatedPerson.contained		0..*	Resource	Contained, inline Resources
RelatedPerson.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension:specimen-animal		1..1	(Complex)	The Species of the Service Animal URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
RelatedPerson.Slices for extension.extension:specimen-animal.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.Slices for extension.extension:specimen-animal.extension		0..0		Extension Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension:specimen-animal.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
RelatedPerson.Slices for extension.extension:specimen-animal.value[x]		1..1	CodeableConcept	Value of extension Binding: eHDSI Animal Species With Exceptions (required)
RelatedPerson.Slices for extension.extension:recordedSexOrGender		0..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.identifier	Σ This element is included in summaries.	0..*	Identifier	A human identifier for this person
RelatedPerson.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this related person's record is in active use
RelatedPerson.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient this person is related to
RelatedPerson.name	Σ This element is included in summaries.	0..*	HumanName	The name of the animal
RelatedPerson.birthDate	Σ This element is included in summaries.	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	required	eHDSI Animal Species With Exceptions	📦1.0.1	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 AnimalSpecimenEuLab

Summary

Maturity: 2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	AnimalSpecimenEuLab	A person that is related to a patient, but who is not a direct target of care
RelatedPerson.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
RelatedPerson.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension:specimen-animal		1..1	(Complex)	The Species of the Service Animal URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
RelatedPerson.Slices for extension.extension:specimen-animal.extension		0..0		Extension Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension:specimen-animal.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
RelatedPerson.Slices for extension.extension:specimen-animal.value[x]		1..1	CodeableConcept	Value of extension Binding: eHDSI Animal Species With Exceptions (required)
RelatedPerson.Slices for extension.extension:recordedSexOrGender		0..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this related person's record is in active use
RelatedPerson.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient this person is related to
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.extension:specimen-animal.​value[x]	Base	required	eHDSI Animal Species With Exceptions	📦1.0.1	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 AnimalSpecimenEuLab

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	AnimalSpecimenEuLab	A person that is related to a patient, but who is not a direct target of care
RelatedPerson.Slices for extension				Content/Rules for all slices
RelatedPerson.Slices for extension.extension:specimen-animal		1..1	PRAnimalSpecies(5.3.0)	The Species of the Service Animal
RelatedPerson.Slices for extension.extension:specimen-animal.value[x]		1..1	CodeableConcept	Value of extension Binding: eHDSI Animal Species With Exceptions (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.extension:specimen-animal.​value[x]	Base	required	eHDSI Animal Species With Exceptions	📦1.0.1	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	AnimalSpecimenEuLab	A person that is related to a patient, but who is not a direct target of care
RelatedPerson.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
RelatedPerson.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
RelatedPerson.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
RelatedPerson.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.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
RelatedPerson.contained		0..*	Resource	Contained, inline Resources
RelatedPerson.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension:specimen-animal		1..1	(Complex)	The Species of the Service Animal URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
RelatedPerson.Slices for extension.extension:specimen-animal.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.Slices for extension.extension:specimen-animal.extension		0..0		Extension Slice: Unordered, Open by value:url
RelatedPerson.Slices for extension.extension:specimen-animal.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
RelatedPerson.Slices for extension.extension:specimen-animal.value[x]		1..1	CodeableConcept	Value of extension Binding: eHDSI Animal Species With Exceptions (required)
RelatedPerson.Slices for extension.extension:recordedSexOrGender		0..1	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.identifier	Σ This element is included in summaries.	0..*	Identifier	A human identifier for this person
RelatedPerson.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this related person's record is in active use
RelatedPerson.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient this person is related to
RelatedPerson.name	Σ This element is included in summaries.	0..*	HumanName	The name of the animal
RelatedPerson.birthDate	Σ This element is included in summaries.	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	required	eHDSI Animal Species With Exceptions	📦1.0.1	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 AnimalSpecimenEuLab

Summary

Maturity: 2

Other representations of profile: CSV, Excel, Schematron