FHIR Extensions Pack
5.1.0 - 5.1.0 (April 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0: Release 5.1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: Patient Animal

Official URL: http://hl7.org/fhir/StructureDefinition/patient-animal Version: 5.1.0
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:

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.

    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 & Constraintsdoco
    .. 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

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. 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"

    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 & Constraintsdoco
    .. 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

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. 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"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:species.value[x]exampleAnimalSpecies
    http://hl7.org/fhir/ValueSet/animal-species
    from this IG
    Extension.extension:breed.value[x]exampleAnimalBreeds
    http://hl7.org/fhir/ValueSet/animal-breeds
    from this IG
    Extension.extension:genderStatus.value[x]exampleGenderStatus (a valid code from gender status code system)
    http://hl7.org/fhir/ValueSet/animal-genderstatus
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)