FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) 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.3.0-ballot-tc1 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.3.0-ballot-tc1
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)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • No changes

    • Formal Views of Extension Content

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

    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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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 Extension
    ..... 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 Extension
    ..... 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 Extension
    ..... 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 Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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 Extension
    Slice: Unordered, Open by value:url
    ..... 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 Extension
    Slice: Unordered, Open by value:url
    ..... 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 Extension
    Slice: Unordered, Open by value:url
    ..... 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"

    doco 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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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 Extension
    ..... 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 Extension
    ..... 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 Extension
    ..... 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 Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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 Extension
    Slice: Unordered, Open by value:url
    ..... 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 Extension
    Slice: Unordered, Open by value:url
    ..... 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 Extension
    Slice: Unordered, Open by value:url
    ..... 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"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Extension.extension:species.​value[x] Base example animal species 📦5.3.0-ballot-tc1 This IG
    Extension.extension:breed.​value[x] Base example animal breeds 📦5.3.0-ballot-tc1 This IG
    Extension.extension:genderStatus.​value[x] Base example gender status value set 📦5.3.0-ballot-tc1 This IG

    Constraints

    Id Grade Path(s) Description Expression
    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()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is unchanged in R3

    Search Parameters for this Extension

    (none found)