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
Patient Administration Work Group | Maturity Level: 1 | Informative | Use Context: Any |
Detailed Descriptions for the elements in the extension.
Extension | |||||||||||||
Element Id | Extension | ||||||||||||
Definition | This patient is known to be an animal. | ||||||||||||
Control | 0..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 |
| ||||||||||||
Extension.id | |||||||||||||
Element Id | Extension.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension | |||||||||||||
Element Id | Extension.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. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, 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. | ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension(species) | |||||||||||||
Element Id | Extension.extension:species | ||||||||||||
Definition | Identifies the high level taxonomic categorization of the kind of animal. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
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 Id | Extension.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. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:species.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Control | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:species.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | uri | ||||||||||||
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 Value | species | ||||||||||||
Extension.extension.valueCodeableConcept | |||||||||||||
Element Id | Extension.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). | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | The species of an animal. For example codes, see Animal species | ||||||||||||
Type | CodeableConcept | ||||||||||||
Extension.extension(breed) | |||||||||||||
Element Id | Extension.extension:breed | ||||||||||||
Definition | Identifies the detailed categorization of the kind of animal. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
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 Id | Extension.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. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:breed.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Control | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:breed.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | uri | ||||||||||||
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 Value | breed | ||||||||||||
Extension.extension.valueCodeableConcept | |||||||||||||
Element Id | Extension.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). | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | The breed of an animal. For example codes, see Animal breeds | ||||||||||||
Type | CodeableConcept | ||||||||||||
Extension.extension(genderStatus) | |||||||||||||
Element Id | Extension.extension:genderStatus | ||||||||||||
Definition | Indicates the current state of the animal's reproductive organs. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.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. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:genderStatus.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Control | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:genderStatus.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | uri | ||||||||||||
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 Value | genderStatus | ||||||||||||
Extension.extension.valueCodeableConcept | |||||||||||||
Element Id | Extension.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). | ||||||||||||
Control | 0..1 | ||||||||||||
Terminology Binding | The state of the animal's reproductive organs. For example codes, see Gender status | ||||||||||||
Type | CodeableConcept | ||||||||||||
Extension.url | |||||||||||||
Element Id | Extension.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | uri | ||||||||||||
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 Value | http://hl7.org/fhir/StructureDefinition/patient-animal | ||||||||||||
Extension.value[x] | |||||||||||||
Element Id | Extension.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). | ||||||||||||
Control | 0..0 | ||||||||||||
Type | Choice 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] Note | See Choice of Data Types for further information about how to use [x] |