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

Example RequestOrchestration/example (Turtle)

Clinical Decision Support Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Raw Turtle (+ also see Turtle/RDF Format Specification)

Simple example request orchestration illustrating related actions with offsets

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

[a fhir:RequestOrchestration;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">Example RequestOrchestration illustrating related actions to administer medications in sequence with time delay.</div>"
  ];
  fhir:DomainResource.contained [
     a fhir:MedicationRequest;
     fhir:index 0;
     fhir:Resource.id [ fhir:value "medicationrequest-1" ];
     fhir:MedicationRequest.status [ fhir:value "unknown" ];
     fhir:MedicationRequest.intent [ fhir:value "proposal" ];
     fhir:MedicationRequest.medication [
       fhir:CodeableReference.concept [
         fhir:CodeableConcept.text [ fhir:value "Medication 1" ]
       ]
     ];
     fhir:MedicationRequest.subject [
       fhir:Reference.reference [ fhir:value "Patient/example" ]
     ]
  ], [
     a fhir:MedicationRequest;
     fhir:index 1;
     fhir:Resource.id [ fhir:value "medicationrequest-2" ];
     fhir:MedicationRequest.status [ fhir:value "unknown" ];
     fhir:MedicationRequest.intent [ fhir:value "proposal" ];
     fhir:MedicationRequest.medication [
       fhir:CodeableReference.concept [
         fhir:CodeableConcept.text [ fhir:value "Medication 2" ]
       ]
     ];
     fhir:MedicationRequest.subject [
       fhir:Reference.reference [ fhir:value "Patient/example" ]
     ]
  ];
  fhir:RequestOrchestration.identifier [
     fhir:index 0;
     fhir:Identifier.value [ fhir:value "requestorchestration-1" ]
  ];
  fhir:RequestOrchestration.groupIdentifier [
     fhir:Identifier.system [ fhir:value "http://example.org/treatment-group" ];
     fhir:Identifier.value [ fhir:value "00001" ]
  ];
  fhir:RequestOrchestration.status [ fhir:value "draft"];
  fhir:RequestOrchestration.intent [ fhir:value "plan"];
  fhir:RequestOrchestration.priority [ fhir:value "routine"];
  fhir:RequestOrchestration.subject [
     fhir:Reference.reference [ fhir:value "Patient/example" ]
  ];
  fhir:RequestOrchestration.encounter [
     fhir:Reference.reference [ fhir:value "Encounter/example" ]
  ];
  fhir:RequestOrchestration.authoredOn [ fhir:value "2017-03-06T17:31:00Z"^^xsd:dateTime];
  fhir:RequestOrchestration.author [
     fhir:Reference.reference [ fhir:value "Practitioner/1" ]
  ];
  fhir:RequestOrchestration.reason [
     fhir:index 0;
     fhir:CodeableReference.concept [
       fhir:CodeableConcept.text [ fhir:value "Treatment" ]
     ]
  ];
  fhir:RequestOrchestration.note [
     fhir:index 0;
     fhir:Annotation.text [ fhir:value "Additional notes about the request group" ]
  ];
  fhir:RequestOrchestration.action [
     fhir:index 0;
     fhir:RequestOrchestration.action.prefix [ fhir:value "1" ];
     fhir:RequestOrchestration.action.title [ fhir:value "Administer Medications" ];
     fhir:RequestOrchestration.action.description [ fhir:value "Administer medications at the appropriate time" ];
     fhir:RequestOrchestration.action.textEquivalent [ fhir:value "Administer medication 1, followed an hour later by medication 2" ];
     fhir:RequestOrchestration.action.timingDateTime [ fhir:value "2017-03-06T19:00:00Z"^^xsd:dateTime ];
     fhir:RequestOrchestration.action.participant [
       fhir:index 0;
       fhir:RequestOrchestration.action.participant.actorReference [
         fhir:Reference.reference [ fhir:value "Practitioner/1" ]
       ]
     ];
     fhir:RequestOrchestration.action.groupingBehavior [ fhir:value "logical-group" ];
     fhir:RequestOrchestration.action.selectionBehavior [ fhir:value "all" ];
     fhir:RequestOrchestration.action.requiredBehavior [ fhir:value "must" ];
     fhir:RequestOrchestration.action.precheckBehavior [ fhir:value "yes" ];
     fhir:RequestOrchestration.action.cardinalityBehavior [ fhir:value "single" ];
     fhir:RequestOrchestration.action.action [
       fhir:index 0;
       fhir:Element.id [ fhir:value "medication-action-1" ];
       fhir:RequestOrchestration.action.description [ fhir:value "Administer medication 1" ];
       fhir:RequestOrchestration.action.type [
         fhir:CodeableConcept.coding [
           fhir:index 0;
           fhir:Coding.code [ fhir:value "create" ]
         ]
       ];
       fhir:RequestOrchestration.action.resource [
         fhir:Reference.reference [ fhir:value "#medicationrequest-1" ]
       ]
     ], [
       fhir:index 1;
       fhir:Element.id [ fhir:value "medication-action-2" ];
       fhir:RequestOrchestration.action.description [ fhir:value "Administer medication 2" ];
       fhir:RequestOrchestration.action.relatedAction [
         fhir:index 0;
         fhir:RequestOrchestration.action.relatedAction.targetId [ fhir:value "medication-action-1" ];
         fhir:RequestOrchestration.action.relatedAction.relationship [ fhir:value "after-end" ];
         fhir:RequestOrchestration.action.relatedAction.offsetDuration [
           fhir:Quantity.value [ fhir:value "1"^^xsd:decimal ];
           fhir:Quantity.unit [ fhir:value "h" ]
         ]
       ];
       fhir:RequestOrchestration.action.type [
         fhir:CodeableConcept.coding [
           fhir:index 0;
           fhir:Coding.code [ fhir:value "create" ]
         ]
       ];
       fhir:RequestOrchestration.action.resource [
         fhir:Reference.reference [ fhir:value "#medicationrequest-2" ]
       ]
     ]
  ]] .

# - ontology header ------------------------------------------------------------

[a owl:Ontology;
  owl:imports fhir:fhir.ttl] .

# -------------------------------------------------------------------------------------


Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.