FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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 R3 R2

Extension: animalSpecies

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

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies

Status: draft. Extension maintained by: HL7

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

Context of Use: Use on element: Practitioner, RelatedPerson

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1CodeableConceptURL = http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
animalSpecies: This extension should be used to specifiy that a practioner or RelatedPerson resource is a service animal.
Binding: AnimalSpecies (example)
Use on element: Practitioner, RelatedPerson

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
animalSpecies: This extension should be used to specifiy that a practioner or RelatedPerson resource is a service animal.
Use on element: Practitioner, RelatedPerson
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: AnimalSpecies (example)

doco Documentation for this format

XML Template

<!-- animalSpecies -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies" >
  <!-- from Element: extension -->
 <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
</extension>

JSON Template

{ // animalSpecies
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies", // R! 
    "valueCodeableConcept" : { CodeableConcept } //Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1CodeableConceptURL = http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
animalSpecies: This extension should be used to specifiy that a practioner or RelatedPerson resource is a service animal.
Binding: AnimalSpecies (example)
Use on element: Practitioner, RelatedPerson

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
animalSpecies: This extension should be used to specifiy that a practioner or RelatedPerson resource is a service animal.
Use on element: Practitioner, RelatedPerson
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: AnimalSpecies (example)

doco Documentation for this format

XML Template

<!-- animalSpecies -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies" >
  <!-- from Element: extension -->
 <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
</extension>

JSON Template

{ // animalSpecies
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies", // R! 
    "valueCodeableConcept" : { CodeableConcept } //Value of extension
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))