Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.0 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2022-09-20 |
@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:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "PlanDefinition-apply"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir: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><a name=\"PlanDefinition-apply-en-NZ\"> </a><p>URL: [base]/PlanDefinition/[id]/$apply</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=\"http://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=\"http://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=\"http://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:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/PlanDefinition-apply"^^xsd:anyURI] ; #
fhir:version [ fhir:v "0.4.0"] ; #
fhir:name [ fhir:v "CareInTheCommunityPlanDefinitionApplyOperation"] ; #
fhir:title [ fhir:v "Care In The Community PlanDefinition Apply Operation"] ; #
fhir:status [ fhir:v "draft"] ; #
fhir:kind [ fhir:v "query"] ; #
fhir:date [ fhir:v "2022-09-20"^^xsd:date] ; #
fhir:publisher [ fhir:v "Te Whatu Ora"] ; #
fhir:contact ( [
fhir:name [ fhir:v "Te Whatu Ora" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://www.tewhatuora.govt.nz/" ] ] )
] [
fhir:name [ fhir:v "David Grainger" ] ;
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "david.grainger@middleware.co.nz" ] ;
fhir:use [ fhir:v "work" ] ] )
] ) ; #
fhir:description [ fhir:v "The apply operation applies a PlanDefinition to a given context"] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "NZ" ] ;
fhir:display [ fhir:v "New Zealand" ] ] )
] ) ; #
fhir:code [ fhir:v "apply"] ; #
fhir:comment [ fhir:v "The result of this operation is a CarePlan resource"] ; #
fhir:base [
fhir:v "http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply>
] ; #
fhir:resource ( [ fhir:v "PlanDefinition"] ) ; #
fhir:system [ fhir:v "false"^^xsd:boolean] ; #
fhir:type [ fhir:v "false"^^xsd:boolean] ; #
fhir:instance [ fhir:v "true"^^xsd:boolean] ; #
fhir:parameter ( [
fhir:name [ fhir:v "planDefinition" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The plan definition to be applied (required)." ] ;
fhir:type [ fhir:v "PlanDefinition" ]
] [
fhir:name [ fhir:v "subject" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The subject Patient that is the target of the plan to be applied." ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "reference" ]
] [
fhir:name [ fhir:v "encounter" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The encounter in context, if any" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "reference" ]
] [
fhir:name [ fhir:v "practitioner" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The practitioner applying the plan definition" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "reference" ]
] [
fhir:name [ fhir:v "return" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The CarePlan that is the result of applying the plan definition" ] ;
fhir:type [ fhir:v "CarePlan" ]
] ) . #
IG © 2022+ Te Whatu Ora. Package tewhatuora.sharedcare#0.4.0 based on FHIR 4.0.1. Generated 2024-11-27
Links: Table of Contents |
QA Report