HL7 Czech Base and Core FHIR IG
1.1.0 - ci-build Czechia flag

HL7 Czech Base and Core FHIR IG, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/cz-core/ and changes regularly. See the Directory of published versions

Resource Profile: RelatedPerson: AnimalSpecimen

Official URL: https://hl7.cz/fhir/core/StructureDefinition/animal-specimen-cz-core Version: 1.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: CZ_AnimalSpecimenCore

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:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson: AnimalSpecimen
... 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
.... identifier:PAS Σ 0..* CZ_Passport_Identifier Passport Number
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient (CZ core)) The patient this person is related to
... name ΣC 0..1 HumanName The name of the animal
Constraints: cz-relPer-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.extension:specimen-animal.​value[x] Base example Types of species 📦1.0.0 HL7 Czech Terminology Implementation Guide v0.3
RelatedPerson.identifier:CPOJ.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cz-relPer-1 error RelatedPerson.name RelatedPerson.name.given, RelatedPerson.name.family, RelatedPerson.name.text or data-absent-reason MUST be filled family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson: AnimalSpecimen
... 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
... Slices for identifier Content/Rules for all slices
.... identifier:RC 0..0 Personal Number
.... identifier:CPOJ 0..0 Health Insurance Number
.... identifier:RID 0..0 National Health Sector Identifier
.... identifier:OP 0..0 National Identity Card Number
... relationship 0..0 The nature of the relationship
... 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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.extension:specimen-animal.​value[x] Base example Types of species 📦1.0.0 HL7 Czech Terminology Implementation Guide v0.3
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson: AnimalSpecimen
... 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:specimen-animal 1..1 (Complex) The Species of the Service Animal
URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
..... id 0..1 string 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
... Slices for identifier Σ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:PAS Σ 0..* CZ_Passport_Identifier Passport Number
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient (CZ core)) The patient this person is related to
... name ΣC 0..1 HumanName The name of the animal
Constraints: cz-relPer-1
.... 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 (often called 'Surname')
.... given Σ 1..* string Given names (not always 'first'). 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
... birthDate Σ 0..1 date The date on which the related person was born

doco 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 📦1.0.0 HL7 Czech Terminology Implementation Guide v0.3
RelatedPerson.identifier:CPOJ.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:CPOJ.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cz-relPer-1 error RelatedPerson.name RelatedPerson.name.given, RelatedPerson.name.family, RelatedPerson.name.text or data-absent-reason MUST be filled family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
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()

Summary

Mandatory: 2 elements
Prohibited: 11 elements

Extensions

This structure refers to these extensions:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson: AnimalSpecimen
... 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
.... identifier:PAS Σ 0..* CZ_Passport_Identifier Passport Number
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient (CZ core)) The patient this person is related to
... name ΣC 0..1 HumanName The name of the animal
Constraints: cz-relPer-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... given Σ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.extension:specimen-animal.​value[x] Base example Types of species 📦1.0.0 HL7 Czech Terminology Implementation Guide v0.3
RelatedPerson.identifier:CPOJ.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cz-relPer-1 error RelatedPerson.name RelatedPerson.name.given, RelatedPerson.name.family, RelatedPerson.name.text or data-absent-reason MUST be filled family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson: AnimalSpecimen
... 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
... Slices for identifier Content/Rules for all slices
.... identifier:RC 0..0 Personal Number
.... identifier:CPOJ 0..0 Health Insurance Number
.... identifier:RID 0..0 National Health Sector Identifier
.... identifier:OP 0..0 National Identity Card Number
... relationship 0..0 The nature of the relationship
... 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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.extension:specimen-animal.​value[x] Base example Types of species 📦1.0.0 HL7 Czech Terminology Implementation Guide v0.3

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson: AnimalSpecimen
... 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:specimen-animal 1..1 (Complex) The Species of the Service Animal
URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
..... id 0..1 string 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
... Slices for identifier Σ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:PAS Σ 0..* CZ_Passport_Identifier Passport Number
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient (CZ core)) The patient this person is related to
... name ΣC 0..1 HumanName The name of the animal
Constraints: cz-relPer-1
.... 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 (often called 'Surname')
.... given Σ 1..* string Given names (not always 'first'). 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
... birthDate Σ 0..1 date The date on which the related person was born

doco 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 📦1.0.0 HL7 Czech Terminology Implementation Guide v0.3
RelatedPerson.identifier:CPOJ.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:CPOJ.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cz-relPer-1 error RelatedPerson.name RelatedPerson.name.given, RelatedPerson.name.family, RelatedPerson.name.text or data-absent-reason MUST be filled family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
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()

Summary

Mandatory: 2 elements
Prohibited: 11 elements

Extensions

This structure refers to these extensions:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron