R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

Extension animal - Detailed Descriptions

Patient Administration Work Group Maturity Level: 1InformativeUse Context: Any

Detailed Descriptions for the elements in the extension.

Extension
Element IdExtension
Definition

This patient is known to be an animal.

Control0..1 This element is affected by the following invariants: ele-1
Comments

The absence of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Extension.id
Element IdExtension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
Extension.extension
Element IdExtension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension(species)
Element IdExtension.extension:species
Definition

Identifies the high level taxonomic categorization of the kind of animal.

Control1..1
TypeExtension
Comments

If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognized taxonomic classification. It might or might not be Linnaean taxonomy and might or might not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.).

Extension.extension.id
Element IdExtension.extension:species.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
Extension.extension.extension
Element IdExtension.extension:species.extension
Definition

An Extension

Control0..0
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension.url
Element IdExtension.extension:species.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuespecies
Extension.extension.valueCodeableConcept
Element IdExtension.extension:species.valueCodeableConcept
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
Terminology BindingThe species of an animal.
For example codes, see Animal species
TypeCodeableConcept
Extension.extension(breed)
Element IdExtension.extension:breed
Definition

Identifies the detailed categorization of the kind of animal.

Control0..1
TypeExtension
Comments

Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.

Extension.extension.id
Element IdExtension.extension:breed.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
Extension.extension.extension
Element IdExtension.extension:breed.extension
Definition

An Extension

Control0..0
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension.url
Element IdExtension.extension:breed.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuebreed
Extension.extension.valueCodeableConcept
Element IdExtension.extension:breed.valueCodeableConcept
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
Terminology BindingThe breed of an animal.
For example codes, see Animal breeds
TypeCodeableConcept
Extension.extension(genderStatus)
Element IdExtension.extension:genderStatus
Definition

Indicates the current state of the animal's reproductive organs.

Control0..1
TypeExtension
Extension.extension.id
Element IdExtension.extension:genderStatus.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
Extension.extension.extension
Element IdExtension.extension:genderStatus.extension
Definition

An Extension

Control0..0
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension.url
Element IdExtension.extension:genderStatus.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValuegenderStatus
Extension.extension.valueCodeableConcept
Element IdExtension.extension:genderStatus.valueCodeableConcept
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
Terminology BindingThe state of the animal's reproductive organs.
For example codes, see Gender status
TypeCodeableConcept
Extension.url
Element IdExtension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-animal
Extension.value[x]
Element IdExtension.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]