Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). 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: 1

Informative

Use 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 practitioner or RelatedPerson resource is a service animal.

Context of Use: Use on Element ID Practitioner or Element ID RelatedPerson

Summary

Name	Flags	Card.	Type	Description & Constraints
animalSpecies		0..1	CodeableConcept	URL = http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies animalSpecies: This extension should be used to specifiy that a practitioner or RelatedPerson resource is a service animal. Binding: AnimalSpecies (example): The species of animal. Use on Element ID Practitioner or Element ID RelatedPerson
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies animalSpecies: This extension should be used to specifiy that a practitioner or RelatedPerson resource is a service animal. Use on Element ID Practitioner or Element ID RelatedPerson
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.
Documentation for this format

XML Template

<!-- animalSpecies -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
animalSpecies		0..1	CodeableConcept	URL = http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies animalSpecies: This extension should be used to specifiy that a practitioner or RelatedPerson resource is a service animal. Binding: AnimalSpecies (example): The species of animal. Use on Element ID Practitioner or Element ID RelatedPerson
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies animalSpecies: This extension should be used to specifiy that a practitioner or RelatedPerson resource is a service animal. Use on Element ID Practitioner or Element ID RelatedPerson
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.
Documentation for this format

XML Template

<!-- animalSpecies -->

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

JSON Template

{ // animalSpecies
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies", // R! 
    "valueCodeableConcept" : { CodeableConcept } // C? R! 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')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)