Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: compliesWith

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/workflow-compliesWith

Version: 5.0.0-ballot

Name: compliesWith

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: The action requested by this resource is intended to satisfy the expectations established by the referenced Definition resource.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG

The action requested by this resource is intended to satisfy the expectations established by the referenced Definition resource.

Comment:

When updating this resource, the determination must be made whether, with the change, the action still complies with the referenced Definition. Revisions may result in compliesWith assertions being removed, or - if the system has an algorithm for determining which targets are appropriate - being added.

Also see the notes in the workflow extensions area for more guidance on this element.

Context of Use: Use on Element ID CarePlan, Element ID CarePlan.activity.plannedActivityDetail, Element ID CommunicationRequest, Element ID DeviceRequest, Element ID ImmunizationRecommendation, Element ID NutritionOrder, Element ID RequestOrchestration, Element ID SupplyRequest, Element ID ServiceRequest or Element ID Task

Summary

Name	Flags	Card.	Type	Description & Constraints
compliesWith		0..*	canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire), Reference(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire), uri	URL = http://hl7.org/fhir/StructureDefinition/workflow-compliesWith compliesWith: The action requested by this resource is intended to satisfy the expectations established by the referenced Definition resource. Use on Element ID CarePlan, Element ID CarePlan.activity.plannedActivityDetail, Element ID CommunicationRequest, Element ID DeviceRequest, Element ID ImmunizationRecommendation, Element ID NutritionOrder, Element ID RequestOrchestration, Element ID SupplyRequest, Element ID ServiceRequest or Element ID Task
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/workflow-compliesWith compliesWith: The action requested by this resource is intended to satisfy the expectations established by the referenced Definition resource. Use on Element ID CarePlan, Element ID CarePlan.activity.plannedActivityDetail, Element ID CommunicationRequest, Element ID DeviceRequest, Element ID ImmunizationRecommendation, Element ID NutritionOrder, Element ID RequestOrchestration, Element ID SupplyRequest, Element ID ServiceRequest or Element ID Task
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/workflow-compliesWith"
value[x]	1..1		Value of extension
valueCanonical		canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)
valueReference		Reference(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)
valueUri		uri
Documentation for this format

XML Template

<!-- compliesWith -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/workflow-compliesWith" >
  <!-- from Element: extension -->
 <value[x]><!-- I 1..1 canonical|Reference(ActivityDefinition)|uri Value of extension --></value[x]>
</extension>

JSON Template

{ // compliesWith
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/workflow-compliesWith", // R! 
  // value[x]: Value of extension. One of these 3:
    "valueCanonical" : "<canonical>", // I R! Value of extension
    "valueReference" : { Reference(ActivityDefinition) }, // I R! Value of extension
    "valueUri" : "<uri>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
compliesWith		0..*	canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire), Reference(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire), uri	URL = http://hl7.org/fhir/StructureDefinition/workflow-compliesWith compliesWith: The action requested by this resource is intended to satisfy the expectations established by the referenced Definition resource. Use on Element ID CarePlan, Element ID CarePlan.activity.plannedActivityDetail, Element ID CommunicationRequest, Element ID DeviceRequest, Element ID ImmunizationRecommendation, Element ID NutritionOrder, Element ID RequestOrchestration, Element ID SupplyRequest, Element ID ServiceRequest or Element ID Task
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/workflow-compliesWith compliesWith: The action requested by this resource is intended to satisfy the expectations established by the referenced Definition resource. Use on Element ID CarePlan, Element ID CarePlan.activity.plannedActivityDetail, Element ID CommunicationRequest, Element ID DeviceRequest, Element ID ImmunizationRecommendation, Element ID NutritionOrder, Element ID RequestOrchestration, Element ID SupplyRequest, Element ID ServiceRequest or Element ID Task
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/workflow-compliesWith"
value[x]	1..1		Value of extension
valueCanonical		canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)
valueReference		Reference(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)
valueUri		uri
Documentation for this format

XML Template

<!-- compliesWith -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/workflow-compliesWith" >
  <!-- from Element: extension -->
 <value[x]><!-- I 1..1 canonical|Reference(ActivityDefinition)|uri Value of extension --></value[x]>
</extension>

JSON Template

{ // compliesWith
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/workflow-compliesWith", // R! 
  // value[x]: Value of extension. One of these 3:
    "valueCanonical" : "<canonical>", // I R! Value of extension
    "valueReference" : { Reference(ActivityDefinition) }, // I R! Value of extension
    "valueUri" : "<uri>" // 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

No examples found.