Package | cinc.fhir.ig |
Type | OperationDefinition |
Id | Id |
FHIR Version | R4 |
Source | https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/OperationDefinition-PlanDefinition-apply.html |
Url | https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/OperationDefinition/PlanDefinition-apply |
Version | 0.4.0 |
Status | draft |
Date | 2022-09-20 |
Name | CareInTheCommunityPlanDefinitionApplyOperation |
Title | Care In The Community PlanDefinition Apply Operation |
Experimental | False |
Realm | nz |
Authority | national |
Description | The apply operation applies a PlanDefinition to a given context |
Type | false |
Kind | operation |
CapabilityStatement | |
SharedCareFHIRAPICapabilityStatement | Shared Care FHIR Server Capability Statement |
SharedCareFHIRAPICapabilityStatement | Shared Care FHIR Server Capability Statement |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition PlanDefinition-apply
URL: [base]/PlanDefinition/[id]/$apply
Parameters
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | planDefinition | 1..1 | PlanDefinition | The plan definition to be applied (required). | ||
IN | subject | 1..1 | string (reference) | The subject Patient that is the target of the plan to be applied. | ||
IN | encounter | 0..1 | string (reference) | The encounter in context, if any | ||
IN | practitioner | 0..1 | string (reference) | The practitioner applying the plan definition | ||
OUT | return | 1..1 | CarePlan | The CarePlan that is the result of applying the plan definition |
The result of this operation is a CarePlan resource
{
"resourceType" : "OperationDefinition",
"id" : "PlanDefinition-apply",
"text" : {
"status" : "generated",
"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=\"hcPlanDefinition-apply-en-NZ\"> </a><p>URL: [base]/PlanDefinition/[id]/$apply</p><p>Parameters</p><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>"
},
"url" : "https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/OperationDefinition/PlanDefinition-apply",
"version" : "0.4.0",
"name" : "CareInTheCommunityPlanDefinitionApplyOperation",
"title" : "Care In The Community PlanDefinition Apply Operation",
"status" : "draft",
"kind" : "operation",
"date" : "2022-09-20",
"publisher" : "Te Whatu Ora",
"contact" : [
{
"name" : "Te Whatu Ora",
"telecom" : [
{
"system" : "url",
"value" : "https://www.tewhatuora.govt.nz/"
}
]
},
{
"name" : "David Grainger",
"telecom" : [
{
"system" : "email",
"value" : "david.grainger@middleware.co.nz",
"use" : "work"
}
]
}
],
"description" : "The apply operation applies a PlanDefinition to a given context",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "NZ",
"display" : "New Zealand"
}
]
}
],
"code" : "apply",
"comment" : "The result of this operation is a CarePlan resource",
"base" : "http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply",
"resource" : [
"PlanDefinition"
],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [
{
"name" : "planDefinition",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The plan definition to be applied (required).",
"type" : "PlanDefinition"
},
{
"name" : "subject",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The subject Patient that is the target of the plan to be applied.",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "encounter",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The encounter in context, if any",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "practitioner",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The practitioner applying the plan definition",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The CarePlan that is the result of applying the plan definition",
"type" : "CarePlan"
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.