Release 4 Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R4B

Extension-valueset-expression.json Extension: Practitioner Animal Species

Vocabulary Patient Administration Work Group   Maturity Level : N/A 1 Standards Status Trial Use Use Context : Informative Any
Official URL : http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies Version : 5.0.0-snapshot3
draft as of 2021-01-02 Computable Name : PRAnimalSpecies
Flags : Non-Modifier OID : 2.16.840.1.113883.4.642.5.1085

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

Definition

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
.. PRAnimalSpecies 0..1 CodeableConcept URL = http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
PRAnimalSpecies: This extension should be used to specifiy that a practitioner or RelatedPerson resource is a service animal.


Binding: AnimalSpecies ( canonical form example + also see JSON Format Specification ): The species of animal.


Use on 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
PRAnimalSpecies: 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.


doco Documentation for this format

expression XML Template

{ "resourceType" : "StructureDefinition", "id" : "valueset-expression", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "vocab" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 1 }], "url" : "http://hl7.org/fhir/StructureDefinition/valueset-expression", "version" : "4.0.1", "name" : "expression", "status" : "draft", "date" : "2019-11-01T09:29:23+11:00", "publisher" : "HL7", "description" : "An expression that provides an alternative definition of the content of the value set. There are two different ways to use this expression extension: If both an expression and a compose element is present, the compose is understood the make the same statement as the expression. If there is no compose, the expression is the only definition of the value set, and the value set can only be processed by a server that understands the expression syntax, it that is computable.", "fhirVersion" : "4.0.1", "mapping" : [{ "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }], "kind" : "complex-type", "abstract" : false, "context" : [{ "type" : "element", "expression" : "ValueSet" }], "type" : "Extension", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension", "derivation" : "constraint", "snapshot" : { "element" : [{ "id" : "Extension", "path" : "Extension", "short" : "An alternative computable expression of the value set content", "definition" : "An expression that provides an alternative definition of the content of the value set. There are two different ways to use this expression extension: If both an expression and a compose element is present, the compose is understood the make the same statement as the expression. If there is no compose, the expression is the only definition of the value set, and the value set can only be processed by a server that understands the expression syntax, it that is computable.", "comment" : "The expression may be a reference or the actual expression, and ss expected to be a computable format (use the [rules-text extension](extension-valueset-rules-text.html) for a non-computable description).", "min" : 0, "max" : "1", "base" : { "path" : "Extension", "min" : 0, "max" : "*" }, "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false }, { "id" : "Extension.id", "path" : "Extension.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Extension.extension", "path" : "Extension.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Extension", "definition" : "An Extension", "min" : 0, "max" : "0", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Extension.url", "path" : "Extension.url", "representation" : ["xmlAttr"], "short" : "identifies the meaning of the extension", "definition" : "Source of the definition for the extension code - a logical name or a URL.", "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min" : 1, "max" : "1", "base" : { "path" : "Extension.url", "min" : 1, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "uri" }], "code" : "http://hl7.org/fhirpath/System.String" }], "fixedUri" : "http://hl7.org/fhir/StructureDefinition/valueset-expression", "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "short" : "Value of extension", "definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list).", "min" : 1, "max" : "1", "base" : { "path" : "Extension.value[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Expression" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }] }, "differential" : { "element" : [{ "id" : "Extension", "path" : "Extension", "short" : "An alternative computable expression of the value set content", "definition" : "An expression that provides an alternative definition of the content of the value set. There are two different ways to use this expression extension: If both an expression and a compose element is present, the compose is understood the make the same statement as the expression. If there is no compose, the expression is the only definition of the value set, and the value set can only be processed by a server that understands the expression syntax, it that is computable.", "comment" : "The expression may be a reference or the actual expression, and ss expected to be a computable format (use the [rules-text extension](extension-valueset-rules-text.html) for a non-computable description).", "min" : 0, "max" : "1" }, { "id" : "Extension.extension", "path" : "Extension.extension", "max" : "0" }, { "id" : "Extension.url", "path" : "Extension.url", "fixedUri" : "http://hl7.org/fhir/StructureDefinition/valueset-expression" }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "min" : 1, "type" : [{ "code" : "Expression" }] }] 
<!-- PRAnimalSpecies -->doco

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

JSON Template 


{ // PRAnimalSpecies
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited

    "url" : "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies", // R! 
    "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension

  }
}

Usage note: every effort has been made Summary

Name Flags Card. Type Description & Constraints doco
.. PRAnimalSpecies 0..1 CodeableConcept URL = http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
PRAnimalSpecies: This extension should be used to ensure specifiy that the examples are correct and useful, but they are 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

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
PRAnimalSpecies: 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.


doco Documentation for this format

XML Template 


<!-- PRAnimalSpecies -->doco

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

JSON Template 


{ // PRAnimalSpecies
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited

    "url" : "http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies", // R! 
    "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()) )
  • ext-1 : Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists() )
  • ele-1 : On Extension.extension: All FHIR elements must have a normative part @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()) )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists() )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()) )

Search

No Search Extensions defined for this resource

Examples of the specification. this extension

No examples found.