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

Extension: expectation

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

Status: draft. Extension maintained by: Health Level Seven, Inc. - [WG Name] WG

Defines the level of expectation associated with a given system capability.

Comment :

If "SHALL NOT" is desired, use the "prohibited" modifier extension. This extension should only be used with CapabilityStatements documenting requirements, not those documenting actual system capabilities.

Context of Use: Use on element: Element ID CapabilityStatement.rest.resource.interaction, Element ID CapabilityStatement.rest.resource.searchParam, Element ID CapabilityStatement.rest.searchParam, Element ID CapabilityStatement.rest.operation, CapabilityStatement.messaging.event, Element ID CapabilityStatement.document, Element ID CapabilityStatement.rest.interaction, CapabilityStatement.rest.resource.searchInclude, Element ID CapabilityStatement.rest.resource.searchInclude or Element ID CapabilityStatement.rest.resource.searchRevInclude

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension expectation 1..1 0..1 code URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
expectation: Defines the level of expectation associated with a given system capability.


Binding: ConformanceExpectation ( required )
Use on element: Element ID CapabilityStatement.rest.resource.interaction, Element ID CapabilityStatement.rest.resource.searchParam, Element ID CapabilityStatement.rest.searchParam, Element ID CapabilityStatement.rest.operation, CapabilityStatement.messaging.event, Element ID CapabilityStatement.document, Element ID CapabilityStatement.rest.interaction, CapabilityStatement.rest.resource.searchInclude, Element ID CapabilityStatement.rest.resource.searchInclude or Element ID CapabilityStatement.rest.resource.searchRevInclude

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 1..1 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
expectation: Defines the level of expectation associated with a given system capability.


Use on element: Element ID CapabilityStatement.rest.resource.interaction, Element ID CapabilityStatement.rest.resource.searchParam, Element ID CapabilityStatement.rest.searchParam, Element ID CapabilityStatement.rest.operation, CapabilityStatement.messaging.event, Element ID CapabilityStatement.document, Element ID CapabilityStatement.rest.interaction, CapabilityStatement.rest.resource.searchInclude, Element ID CapabilityStatement.rest.resource.searchInclude or Element ID CapabilityStatement.rest.resource.searchRevInclude
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
. . valueCode . value[x] I 0..1 1..1 code Value of extension
Binding: ConformanceExpectation ( required )

doco Documentation for this format

XML Template 

<!-- expectation -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" >
  <!-- from Element: extension -->
 <

 <valueCode value="[code]"/><!-- ?? 1..1 Value of extension -->

</extension>

JSON Template 

{ // expectation
  // from Element: extension
    "
    ],

    "extension" : [ //  sliced by value:url  in the specified order, Open ]

    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", // R! 
    "

    "valueCode" : "<code>" // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension expectation 1..1 0..1 code URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
expectation: Defines the level of expectation associated with a given system capability.


Binding: ConformanceExpectation ( required )
Use on element: Element ID CapabilityStatement.rest.resource.interaction, Element ID CapabilityStatement.rest.resource.searchParam, Element ID CapabilityStatement.rest.searchParam, Element ID CapabilityStatement.rest.operation, CapabilityStatement.messaging.event, Element ID CapabilityStatement.document, Element ID CapabilityStatement.rest.interaction, CapabilityStatement.rest.resource.searchInclude, Element ID CapabilityStatement.rest.resource.searchInclude or Element ID CapabilityStatement.rest.resource.searchRevInclude

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 1..1 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
expectation: Defines the level of expectation associated with a given system capability.


Use on element: Element ID CapabilityStatement.rest.resource.interaction, Element ID CapabilityStatement.rest.resource.searchParam, Element ID CapabilityStatement.rest.searchParam, Element ID CapabilityStatement.rest.operation, CapabilityStatement.messaging.event, Element ID CapabilityStatement.document, Element ID CapabilityStatement.rest.interaction, CapabilityStatement.rest.resource.searchInclude, Element ID CapabilityStatement.rest.resource.searchInclude or Element ID CapabilityStatement.rest.resource.searchRevInclude
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
. . valueCode . value[x] I 0..1 1..1 code Value of extension
Binding: ConformanceExpectation ( required )

doco Documentation for this format

XML Template 

<!-- expectation -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" >
  <!-- from Element: extension -->
 <

 <valueCode value="[code]"/><!-- ?? 1..1 Value of extension -->

</extension>

JSON Template 

{ // expectation
  // from Element: extension
    "
    ],

    "extension" : [ //  sliced by value:url  in the specified order, Open ]

    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", // R! 
    "

    "valueCode" : "<code>" // 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 )