FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 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 practioner or RelatedPerson resource is a service animal.

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

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension animalSpecies 0..1 CodeableConcept URL = 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 Animal species ( example )
Use on element: Practitioner, Element ID Practitioner or Element ID RelatedPerson

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = 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, Element ID Practitioner or Element ID RelatedPerson
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies" "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
. . valueCodeableConcept . value[x] I 0..1 1..1 CodeableConcept Value of extension
Binding: AnimalSpecies Animal species ( 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>

 <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 doco
. . extension animalSpecies 0..1 CodeableConcept URL = 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 Animal species ( example )
Use on element: Practitioner, Element ID Practitioner or Element ID RelatedPerson

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = 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, Element ID Practitioner or Element ID RelatedPerson
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies" "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies"
. . valueCodeableConcept . value[x] I 0..1 1..1 CodeableConcept Value of extension
Binding: AnimalSpecies Animal species ( 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>

 <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 )