FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) International flag

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions

Extension: Practitioner Animal Species

Official URL: http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Patient Administration Computable Name: PRAnimalSpecies
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1085

This extension should be used to specifiy that a practitioner or RelatedPerson resource is a service animal.

Context of Use

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

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

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

    Simple Extension with the type CodeableConcept: This extension should be used to specifiy that a practitioner or RelatedPerson resource is a service animal.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The Species of the Service Animal
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
    ... value[x] 1..1 CodeableConcept Value of extension
    Binding: AnimalSpecies (example): The species of animal.

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The Species of the Service Animal
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type CodeableConcept: This extension should be used to specifiy that a practitioner or RelatedPerson resource is a service animal.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The Species of the Service Animal
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
    ... value[x] 1..1 CodeableConcept Value of extension
    Binding: AnimalSpecies (example): The species of animal.

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension The Species of the Service Animal
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.value[x]exampleAnimalSpecies
    http://hl7.org/fhir/ValueSet/animal-species
    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()

    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)