Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Care In The Community PlanDefinition Apply Operation - TTL Representation

Draft as of 2022-09-20

Raw ttl | Download


@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 -------------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply> a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "PlanDefinition-apply"] ;
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ] ;
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition PlanDefinition-apply</b></p><a name=\"PlanDefinition-apply\"> </a><a name=\"hcPlanDefinition-apply\"> </a><p>URL: [base]/PlanDefinition/[id]?_query=apply&amp;...</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>planDefinition</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/plandefinition.html\">PlanDefinition</a></td><td/><td><div><p>The plan definition to be applied (required).</p>\n</div></td></tr><tr><td>IN</td><td>subject</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>The subject Patient that is the target of the plan to be applied.</p>\n</div></td></tr><tr><td>IN</td><td>encounter</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>The encounter in context, if any</p>\n</div></td></tr><tr><td>IN</td><td>practitioner</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"https://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>The practitioner applying the plan definition</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/careplan.html\">CarePlan</a></td><td/><td><div><p>The CarePlan that is the result of applying the plan definition</p>\n</div></td></tr></table><div><p>The result of this operation is a CarePlan resource</p>\n</div></div>"
  ] ;
  fhir:OperationDefinition.url [ fhir:value "https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/PlanDefinition-apply"] ;
  fhir:OperationDefinition.version [ fhir:value "0.4.5"] ;
  fhir:OperationDefinition.name [ fhir:value "CareInTheCommunityPlanDefinitionApplyOperation"] ;
  fhir:OperationDefinition.title [ fhir:value "Care In The Community PlanDefinition Apply Operation"] ;
  fhir:OperationDefinition.status [ fhir:value "draft"] ;
  fhir:OperationDefinition.kind [ fhir:value "query"] ;
  fhir:OperationDefinition.date [ fhir:value "2022-09-20"^^xsd:date] ;
  fhir:OperationDefinition.publisher [ fhir:value "Te Whatu Ora"] ;
  fhir:OperationDefinition.contact [
     fhir:index 0 ;
     fhir:ContactDetail.name [ fhir:value "Te Whatu Ora" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "url" ] ;
       fhir:ContactPoint.value [ fhir:value "https://www.tewhatuora.govt.nz/" ]
     ]
  ], [
     fhir:index 1 ;
     fhir:ContactDetail.name [ fhir:value "Te Whatu Ora Integration Team" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "email" ] ;
       fhir:ContactPoint.value [ fhir:value "integration@tewhatuora.govt.nz" ] ;
       fhir:ContactPoint.use [ fhir:value "work" ]
     ]
  ] ;
  fhir:OperationDefinition.description [ fhir:value "The apply operation applies a PlanDefinition to a given context"] ;
  fhir:OperationDefinition.jurisdiction [
     fhir:index 0 ;
     fhir:CodeableConcept.coding [
       fhir:index 0 ;
       fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ] ;
       fhir:Coding.code [ fhir:value "NZ" ] ;
       fhir:Coding.display [ fhir:value "New Zealand" ]
     ]
  ] ;
  fhir:OperationDefinition.code [ fhir:value "apply"] ;
  fhir:OperationDefinition.comment [ fhir:value "The result of this operation is a CarePlan resource"] ;
  fhir:OperationDefinition.base [
     fhir:value "http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply" ;
     fhir:link <http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply>
  ] ;
  fhir:OperationDefinition.resource [
     fhir:value "PlanDefinition" ;
     fhir:index 0
  ] ;
  fhir:OperationDefinition.system [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.type [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.instance [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.parameter [
     fhir:index 0 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "planDefinition" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "The plan definition to be applied (required)." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "PlanDefinition" ]
  ], [
     fhir:index 1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "subject" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "The subject Patient that is the target of the plan to be applied." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "string" ] ;
     fhir:OperationDefinition.parameter.searchType [ fhir:value "reference" ]
  ], [
     fhir:index 2 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "encounter" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "The encounter in context, if any" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "string" ] ;
     fhir:OperationDefinition.parameter.searchType [ fhir:value "reference" ]
  ], [
     fhir:index 3 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "practitioner" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "The practitioner applying the plan definition" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "string" ] ;
     fhir:OperationDefinition.parameter.searchType [ fhir:value "reference" ]
  ], [
     fhir:index 4 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "return" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "The CarePlan that is the result of applying the plan definition" ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "CarePlan" ]
  ] .

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

<http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/OperationDefinition/PlanDefinition-apply.ttl> .