Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.0 - release
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 |
{
"resourceType" : "OperationDefinition",
"id" : "ActivityDefinition-apply",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition ActivityDefinition-apply</b></p><a name=\"ActivityDefinition-apply\"> </a><a name=\"hcActivityDefinition-apply\"> </a><a name=\"ActivityDefinition-apply-en-NZ\"> </a><p>URL: [base]/ActivityDefinition/[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>activityDefinition</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/activitydefinition.html\">ActivityDefinition</a></td><td/><td><div><p>The activity 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 activity to be applied.</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 activity 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/servicerequest.html\">ServiceRequest</a></td><td/><td><div><p>The ServiceRequest that is the result of applying the plan definition</p>\n</div></td></tr></table><div><p>The result of this operation is a ServiceRequest resource</p>\n</div></div>"
},
"url" : "https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/ActivityDefinition-apply",
"version" : "0.4.0",
"name" : "CareInTheCommunityActivityDefinitionApplyOperation",
"title" : "Care In The Community ActivityDefinition 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 an ActivityDefinition 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 ServiceRequest resource",
"base" : "http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply",
"resource" : [
"ActivityDefinition"
],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [
{
"name" : "activityDefinition",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The activity definition to be applied (required).",
"type" : "ActivityDefinition"
},
{
"name" : "subject",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The subject Patient that is the target of the activity to be applied.",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "practitioner",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The practitioner applying the activity definition",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The ServiceRequest that is the result of applying the plan definition",
"type" : "ServiceRequest"
}
]
}