HL7.FHIR.UV.EXTENSIONS\Patient Animal

FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Patient Animal

Official URL: http://hl7.org/fhir/StructureDefinition/patient-animal			Version: 5.2.0-ballot
Standards status: Trial-use	Maturity Level: 3	Responsible: HL7 International / Patient Administration	Computable Name: PatAnimal
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1343

This patient is known to be an animal.

Context of Use

This extension may be used on the following element(s):

Element ID Patient

Usage info

Usage:

Examples for this Extension: An example of an animal

Changes since version 1.0.0:

The resource metadata has changed (publisher)

Formal Views of Extension Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from Extension

Summary

Complex Extension: This patient is known to be an animal.

species: CodeableConcept: Identifies the high level taxonomic categorization of the kind of animal.
breed: CodeableConcept: Identifies the detailed categorization of the kind of animal.
genderStatus: CodeableConcept: Indicates the current state of the animal's reproductive organs.

Maturity: 3

This structure is derived from Extension

Name	Card.	Type	Description & Constraints
Extension	0..1	Extension	This patient is known to be an animal (non-human)
Slices for extension			Content/Rules for all slices
extension:species	1..1	Extension	The animal species. E.g. Dog, Cow.
extension	0..0
url	1..1	uri	"species"
value[x]	1..1	CodeableConcept	Value of extension Binding: AnimalSpecies (example): The species of an animal.
extension:breed	0..1	Extension	The animal breed. E.g. Poodle, Angus.
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.
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"
value[x]	0..0
Documentation for this format

Name	Card.	Type	Description & Constraints
Extension	0..1	Extension	This patient is known to be an animal (non-human)
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	The animal species. E.g. Dog, Cow.
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: AnimalSpecies (example): The species of an animal.
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"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This patient is known to be an animal.

species: CodeableConcept: Identifies the high level taxonomic categorization of the kind of animal.
breed: CodeableConcept: Identifies the detailed categorization of the kind of animal.
genderStatus: CodeableConcept: Indicates the current state of the animal's reproductive organs.

Maturity: 3

Differential View

This structure is derived from Extension

Name	Card.	Type	Description & Constraints
Extension	0..1	Extension	This patient is known to be an animal (non-human)
Slices for extension			Content/Rules for all slices
extension:species	1..1	Extension	The animal species. E.g. Dog, Cow.
extension	0..0
url	1..1	uri	"species"
value[x]	1..1	CodeableConcept	Value of extension Binding: AnimalSpecies (example): The species of an animal.
extension:breed	0..1	Extension	The animal breed. E.g. Poodle, Angus.
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.
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"
value[x]	0..0
Documentation for this format

Snapshot View

Name	Card.	Type	Description & Constraints
Extension	0..1	Extension	This patient is known to be an animal (non-human)
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	The animal species. E.g. Dog, Cow.
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: AnimalSpecies (example): The species of an animal.
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"
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet	URI
Extension.extension:species.value[x]	example	AnimalSpecies `http://hl7.org/fhir/ValueSet/animal-species` from this IG
Extension.extension:breed.value[x]	example	AnimalBreeds `http://hl7.org/fhir/ValueSet/animal-breeds` from this IG
Extension.extension:genderStatus.value[x]	example	GenderStatus (a valid code from gender status code system) `http://hl7.org/fhir/ValueSet/animal-genderstatus` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Search Parameters for this Extension

(none found)

IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.extensions#5.2.0-ballot based on FHIR 5.0.0. Generated 2024-12-19
Links: Table of Contents | QA Report | Version History | | Propose a change