Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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

Extension: expectation

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

Name: expectation

Title: Conformance expectation

Modifier: This extension is not a modifier extension

Status: draft

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

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: HL7

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 ID CapabilityStatement.document, Element ID CapabilityStatement.format, Element ID CapabilityStatement.implementationGuide, Element ID CapabilityStatement.imports, Element ID CapabilityStatement.instantiates, Element ID CapabilityStatement.patchFormat, Element ID CapabilityStatement.rest.interaction, Element ID CapabilityStatement.rest.interaction.code, Element ID CapabilityStatement.rest.interaction.documentation, Element ID CapabilityStatement.rest.operation, Element ID CapabilityStatement.rest.resource, Element ID CapabilityStatement.rest.resource.extension, Element ID CapabilityStatement.rest.resource.conditionalCreate, Element ID CapabilityStatement.rest.resource.conditionalDelete, Element ID CapabilityStatement.rest.resource.conditionalRead, Element ID CapabilityStatement.rest.resource.conditionalUpdate, Element ID CapabilityStatement.rest.resource.conditionalPatch, Element ID CapabilityStatement.rest.resource.interaction, Element ID CapabilityStatement.rest.resource.operation, Element ID CapabilityStatement.rest.resource.profile, Element ID CapabilityStatement.rest.resource.readHistory, Element ID CapabilityStatement.rest.resource.referencePolicy, Element ID CapabilityStatement.rest.resource.searchInclude, Element ID CapabilityStatement.rest.resource.searchParam, Element ID CapabilityStatement.rest.resource.searchRevInclude, Element ID CapabilityStatement.rest.resource.supportedProfile, Element ID CapabilityStatement.rest.resource.updateCreate, Element ID CapabilityStatement.rest.resource.versioning, Element ID CapabilityStatement.rest.searchParam, Element ID CapabilityStatement.rest.security, Element ID CapabilityStatement.rest.security.cors, Element ID CapabilityStatement.rest.security.service or Extension URL http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination

Summary

Name	Flags	Card.	Type	Description & Constraints
expectation		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): Indicates the degree of adherence to a specified behavior or capability expected for a system to be deemed conformant with a specification. Use on Element ID CapabilityStatement.document, Element ID CapabilityStatement.format, Element ID CapabilityStatement.implementationGuide, Element ID CapabilityStatement.imports, Element ID CapabilityStatement.instantiates, Element ID CapabilityStatement.patchFormat, Element ID CapabilityStatement.rest.interaction, Element ID CapabilityStatement.rest.interaction.code, Element ID CapabilityStatement.rest.interaction.documentation, Element ID CapabilityStatement.rest.operation, Element ID CapabilityStatement.rest.resource, Element ID CapabilityStatement.rest.resource.extension, Element ID CapabilityStatement.rest.resource.conditionalCreate, Element ID CapabilityStatement.rest.resource.conditionalDelete, Element ID CapabilityStatement.rest.resource.conditionalRead, Element ID CapabilityStatement.rest.resource.conditionalUpdate, Element ID CapabilityStatement.rest.resource.conditionalPatch, Element ID CapabilityStatement.rest.resource.interaction, Element ID CapabilityStatement.rest.resource.operation, Element ID CapabilityStatement.rest.resource.profile, Element ID CapabilityStatement.rest.resource.readHistory, Element ID CapabilityStatement.rest.resource.referencePolicy, Element ID CapabilityStatement.rest.resource.searchInclude, Element ID CapabilityStatement.rest.resource.searchParam, Element ID CapabilityStatement.rest.resource.searchRevInclude, Element ID CapabilityStatement.rest.resource.supportedProfile, Element ID CapabilityStatement.rest.resource.updateCreate, Element ID CapabilityStatement.rest.resource.versioning, Element ID CapabilityStatement.rest.searchParam, Element ID CapabilityStatement.rest.security, Element ID CapabilityStatement.rest.security.cors, Element ID CapabilityStatement.rest.security.service or Extension URL http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	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 ID CapabilityStatement.document, Element ID CapabilityStatement.format, Element ID CapabilityStatement.implementationGuide, Element ID CapabilityStatement.imports, Element ID CapabilityStatement.instantiates, Element ID CapabilityStatement.patchFormat, Element ID CapabilityStatement.rest.interaction, Element ID CapabilityStatement.rest.interaction.code, Element ID CapabilityStatement.rest.interaction.documentation, Element ID CapabilityStatement.rest.operation, Element ID CapabilityStatement.rest.resource, Element ID CapabilityStatement.rest.resource.extension, Element ID CapabilityStatement.rest.resource.conditionalCreate, Element ID CapabilityStatement.rest.resource.conditionalDelete, Element ID CapabilityStatement.rest.resource.conditionalRead, Element ID CapabilityStatement.rest.resource.conditionalUpdate, Element ID CapabilityStatement.rest.resource.conditionalPatch, Element ID CapabilityStatement.rest.resource.interaction, Element ID CapabilityStatement.rest.resource.operation, Element ID CapabilityStatement.rest.resource.profile, Element ID CapabilityStatement.rest.resource.readHistory, Element ID CapabilityStatement.rest.resource.referencePolicy, Element ID CapabilityStatement.rest.resource.searchInclude, Element ID CapabilityStatement.rest.resource.searchParam, Element ID CapabilityStatement.rest.resource.searchRevInclude, Element ID CapabilityStatement.rest.resource.supportedProfile, Element ID CapabilityStatement.rest.resource.updateCreate, Element ID CapabilityStatement.rest.resource.versioning, Element ID CapabilityStatement.rest.searchParam, Element ID CapabilityStatement.rest.security, Element ID CapabilityStatement.rest.security.cors, Element ID CapabilityStatement.rest.security.service or Extension URL http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
value[x]	1..1	code	Value of extension Binding: ConformanceExpectation (required): Indicates the degree of adherence to a specified behavior or capability expected for a system to be deemed conformant with a specification.
Documentation for this format

XML Template

<!-- expectation -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // expectation
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", // R! 
    "valueCode" : "<code>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
expectation		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): Indicates the degree of adherence to a specified behavior or capability expected for a system to be deemed conformant with a specification. Use on Element ID CapabilityStatement.document, Element ID CapabilityStatement.format, Element ID CapabilityStatement.implementationGuide, Element ID CapabilityStatement.imports, Element ID CapabilityStatement.instantiates, Element ID CapabilityStatement.patchFormat, Element ID CapabilityStatement.rest.interaction, Element ID CapabilityStatement.rest.interaction.code, Element ID CapabilityStatement.rest.interaction.documentation, Element ID CapabilityStatement.rest.operation, Element ID CapabilityStatement.rest.resource, Element ID CapabilityStatement.rest.resource.extension, Element ID CapabilityStatement.rest.resource.conditionalCreate, Element ID CapabilityStatement.rest.resource.conditionalDelete, Element ID CapabilityStatement.rest.resource.conditionalRead, Element ID CapabilityStatement.rest.resource.conditionalUpdate, Element ID CapabilityStatement.rest.resource.conditionalPatch, Element ID CapabilityStatement.rest.resource.interaction, Element ID CapabilityStatement.rest.resource.operation, Element ID CapabilityStatement.rest.resource.profile, Element ID CapabilityStatement.rest.resource.readHistory, Element ID CapabilityStatement.rest.resource.referencePolicy, Element ID CapabilityStatement.rest.resource.searchInclude, Element ID CapabilityStatement.rest.resource.searchParam, Element ID CapabilityStatement.rest.resource.searchRevInclude, Element ID CapabilityStatement.rest.resource.supportedProfile, Element ID CapabilityStatement.rest.resource.updateCreate, Element ID CapabilityStatement.rest.resource.versioning, Element ID CapabilityStatement.rest.searchParam, Element ID CapabilityStatement.rest.security, Element ID CapabilityStatement.rest.security.cors, Element ID CapabilityStatement.rest.security.service or Extension URL http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	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 ID CapabilityStatement.document, Element ID CapabilityStatement.format, Element ID CapabilityStatement.implementationGuide, Element ID CapabilityStatement.imports, Element ID CapabilityStatement.instantiates, Element ID CapabilityStatement.patchFormat, Element ID CapabilityStatement.rest.interaction, Element ID CapabilityStatement.rest.interaction.code, Element ID CapabilityStatement.rest.interaction.documentation, Element ID CapabilityStatement.rest.operation, Element ID CapabilityStatement.rest.resource, Element ID CapabilityStatement.rest.resource.extension, Element ID CapabilityStatement.rest.resource.conditionalCreate, Element ID CapabilityStatement.rest.resource.conditionalDelete, Element ID CapabilityStatement.rest.resource.conditionalRead, Element ID CapabilityStatement.rest.resource.conditionalUpdate, Element ID CapabilityStatement.rest.resource.conditionalPatch, Element ID CapabilityStatement.rest.resource.interaction, Element ID CapabilityStatement.rest.resource.operation, Element ID CapabilityStatement.rest.resource.profile, Element ID CapabilityStatement.rest.resource.readHistory, Element ID CapabilityStatement.rest.resource.referencePolicy, Element ID CapabilityStatement.rest.resource.searchInclude, Element ID CapabilityStatement.rest.resource.searchParam, Element ID CapabilityStatement.rest.resource.searchRevInclude, Element ID CapabilityStatement.rest.resource.supportedProfile, Element ID CapabilityStatement.rest.resource.updateCreate, Element ID CapabilityStatement.rest.resource.versioning, Element ID CapabilityStatement.rest.searchParam, Element ID CapabilityStatement.rest.security, Element ID CapabilityStatement.rest.security.cors, Element ID CapabilityStatement.rest.security.service or Extension URL http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
value[x]	1..1	code	Value of extension Binding: ConformanceExpectation (required): Indicates the degree of adherence to a specified behavior or capability expected for a system to be deemed conformant with a specification.
Documentation for this format

XML Template

<!-- expectation -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // expectation
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", // R! 
    "valueCode" : "<code>" // I 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)

Search

No Search Extensions defined for this resource

Examples of this extension

TerminologyServer: CapabilityStatement/example-terminology-server