This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-draft-final:
Final
QA
Preview
for
R5
-
STU
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
.
Page
versions:
R5
R4B
R4
R3
| Orders and Observations Work Group | Maturity Level : N/A | Standards Status : Informative |
Compartments
:
|
Raw JSON ( canonical form + also see JSON Format Specification )
Example of in-progress/awaiting specimen task for a lipid panel order
Workflow
{
"resourceType": "Task",
"id": "example1",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource "example1" </p></div><p><b>identifier</b>: id: 20170201-001 (OFFICIAL)</p><p><b>basedOn</b>: <span>: General Wellness Careplan</span></p><p><b>groupIdentifier</b>: id: G20170201-001 (OFFICIAL)</p><p><b>status</b>: in-progress</p><p><b>businessStatus</b>: waiting for specimen <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>intent</b>: order</p><p><b>priority</b>: routine</p><p><b>code</b>: Lipid Panel <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>description</b>: Create order for getting specimen, Set up inhouse testing, generate order for any sendouts and submit with specimen</p><p><b>focus</b>: <a href=\"servicerequest-lipid.html\">ServiceRequest/lipid: Lipid Panel Request</a></p><p><b>for</b>: <a href=\"patient-example.html\">Patient/example: Peter James Chalmers</a> "Peter CHALMERS"</p><p><b>encounter</b>: <a href=\"encounter-example.html\">Encounter/example: Example In-Patient Encounter</a></p><p><b>executionPeriod</b>: 2016-10-31T08:25:05+10:00 --> (ongoing)</p><p><b>authoredOn</b>: 2016-10-31T08:25:05+10:00</p><p><b>lastModified</b>: 2016-10-31T09:45:05+10:00</p><p><b>requester</b>: <a href=\"practitioner-example.html\">Practitioner/example: Dr Adam Careful</a> "Adam CAREFUL"</p><p><b>performerType</b>: Performer <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (task-performer-type#performer)</span></p><p><b>owner</b>: <a href=\"organization-1832473e-2fe0-452d-abe9-3cdb9879522f.html\">Organization/1832473e-2fe0-452d-abe9-3cdb9879522f: Clinical Laboratory @ Acme Hospital</a> "Clinical Lab"</p><p><b>reasonCode</b>: The Task.reason should only be included if there is no Task.focus or if it differs from the reason indicated on the focus <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>note</b>: This is an example to demonstrate using task for actioning a servicerequest and to illustrate how to populate many of the task elements - this is the parent task that will be broken into subtask to grab the specimen and a sendout lab test</p><p><b>relevantHistory</b>: <a name=\"signature\"> </a></p><blockquote><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource "signature" </p></div><p><b>target</b>: <a href=\"servicerequest-physiotherapy.html\">ServiceRequest/physiotherapy/_history/1</a></p><p><b>recorded</b>: 31/10/2016 9:25:05 AM</p><h3>Agents</h3><table class=\"grid\"><tr><td>-</td><td><b>Role</b></td><td><b>Who</b></td></tr><tr><td>*</td><td>author (originator) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v3-ParticipationType.html\">ParticipationType</a>#AUT)</span></td><td><a href=\"practitioner-f202.html\">Practitioner/f202: Luigi Maas</a> "Luigi Maas"</td></tr></table></blockquote><h3>Restrictions</h3><table class=\"grid\"><tr><td>-</td><td><b>Repetitions</b></td><td><b>Period</b></td></tr><tr><td>*</td><td>1</td><td>?? --> 2016-11-02T09:45:05+10:00</td></tr></table></div>"
"resourceType" : "Task",
"id" : "example1",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: Task</b><a name=\"example1\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource Task "example1" </p></div><p><b>identifier</b>: id: 20170201-001 (use: OFFICIAL)</p><p><b>basedOn</b>: <span>: General Wellness Careplan</span></p><p><b>groupIdentifier</b>: id: G20170201-001 (use: OFFICIAL)</p><p><b>status</b>: in-progress</p><p><b>businessStatus</b>: <span title=\" fictive business status populated for this example \">waiting for specimen <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></span></p><p><b>intent</b>: order</p><p><b>priority</b>: routine</p><p><b>code</b>: <span title=\" fictive code and description elements populated for this example \">Lipid Panel <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-task-code.html\">Task Codes</a>#fulfill)</span></span></p><p><b>description</b>: Create order for getting specimen, Set up inhouse testing, generate order for any sendouts and submit with specimen</p><p><b>focus</b>: <span title=\" \tUse the lipid servicerequest example \"><a href=\"servicerequest-example-lipid.html\">ServiceRequest/lipid: Lipid Panel Request</a></span></p><p><b>for</b>: <span title=\" \twho the task is for\n \"><a href=\"patient-example.html\">Patient/example: Peter James Chalmers</a> "Peter CHALMERS"</span></p><p><b>encounter</b>: <a href=\"encounter-example.html\">Encounter/example: Example In-Patient Encounter</a></p><p><b>executionPeriod</b>: <span title=\" \tLots of dates \">2016-10-31T08:25:05+10:00 --> (ongoing)</span></p><p><b>authoredOn</b>: 2016-10-31T08:25:05+10:00</p><p><b>lastModified</b>: 2016-10-31T09:45:05+10:00</p><p><b>requester</b>: <a href=\"practitioner-example.html\">Practitioner/example: Dr Adam Careful</a> "Adam CAREFUL"</p><h3>RequestedPerformers</h3><table class=\"grid\"><tr><td>-</td><td><b>Concept</b></td></tr><tr><td>*</td><td>Performer <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#18850004 "Laboratory hematologist")</span></td></tr></table><p><b>owner</b>: <a href=\"organization-example-lab.html\">Organization/1832473e-2fe0-452d-abe9-3cdb9879522f: Clinical Laboratory @ Acme Hospital</a> "Clinical Lab"</p><h3>Reasons</h3><table class=\"grid\"><tr><td>-</td><td><b>Concept</b></td></tr><tr><td>*</td><td>The Task.reason should only be included if there is no Task.focus or if it differs from the reason indicated on the focus <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></td></tr></table><p><b>note</b>: This is an example to demonstrate using task for actioning a servicerequest and to illustrate how to populate many of the task elements - this is the parent task that will be broken into subtask to grab the specimen and a sendout lab test</p><p><b>relevantHistory</b>: <span title=\" \tadd the link to the signature on the task to show how this element is usedemonstrating in this example the relevant history element using a contained resource for the purpose of this example only typically would reference an external resource\n\n \"><a name=\"signature\"> </a></span></p><blockquote><p/><p><a name=\"signature\"> </a></p><p><b>target</b>: <a href=\"servicerequest-example2.html\">ServiceRequest/physiotherapy/_history/1</a></p><p><b>recorded</b>: 31 Oct 2016, 9:25:05 am</p><h3>Agents</h3><table class=\"grid\"><tr><td>-</td><td><b>Role</b></td><td><b>Who</b></td></tr><tr><td>*</td><td>author (originator) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-ParticipationType.html\">ParticipationType</a>#AUT)</span></td><td><a href=\"practitioner-example-f202-lm.html\">Practitioner/f202: Luigi Maas</a> "Luigi Maas"</td></tr></table><h3>Signatures</h3><table class=\"grid\"><tr><td>-</td><td><b>Type</b></td><td><b>When</b></td><td><b>Who</b></td><td><b>TargetFormat</b></td><td><b>SigFormat</b></td><td><b>Data</b></td></tr><tr><td>*</td><td>Author's Signature (Details: urn:iso-astm:E1762-95:2013 code 1.2.840.10065.1.12.1.1 = 'Author's Signature', stated as 'Author's Signature')</td><td>31 Oct 2016, 9:25:05 am</td><td><a href=\"practitioner-example.html\">Practitioner/example: Dr Adam Careful</a> "Adam CAREFUL"</td><td>application/fhir+xml</td><td>application/signature+xml</td><td>dGhpcyBibG9iIGlzIHNuaXBwZWQ=</td></tr></table></blockquote><h3>Restrictions</h3><table class=\"grid\"><tr><td>-</td><td><b>Repetitions</b></td><td><b>Period</b></td></tr><tr><td>*</td><td>1</td><td>?? --> 2016-11-02T09:45:05+10:00</td></tr></table></div>"
},
"contained": [
{
"resourceType": "Provenance",
"id": "signature",
"target": [
{
"reference": "ServiceRequest/physiotherapy/_history/1"
}
],
"recorded": "2016-10-31T08:25:05+10:00",
"agent": [
{
"role": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "AUT"
}
]
}
],
"who": {
"reference": "Practitioner/f202",
"display": "Luigi Maas"
}
}
],
"signature": [
{
"type": [
{
"system": "urn:iso-astm:E1762-95:2013",
"code": "1.2.840.10065.1.12.1.1",
"display": "Author's Signature"
}
],
"when": "2016-10-31T08:25:05+10:00",
"who": {
"reference": "Practitioner/example",
"display": "Dr Adam Careful"
},
"targetFormat": "application/fhir+xml",
"sigFormat": "application/signature+xml",
"data": "dGhpcyBibG9iIGlzIHNuaXBwZWQ="
}
]
}
],
"identifier": [
{
"use": "official",
"system": "http:/goodhealth.org/identifiers",
"value": "20170201-001"
}
],
"basedOn": [
{
"display": "General Wellness Careplan"
}
],
"groupIdentifier": {
"use": "official",
"system": "http:/goodhealth.org/accession/identifiers",
"value": "G20170201-001"
"contained" : [{
"resourceType" : "Provenance",
"id" : "signature",
"target" : [{
"reference" : "ServiceRequest/physiotherapy/_history/1"
}],
"recorded" : "2016-10-31T08:25:05+10:00",
"agent" : [{
"role" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code" : "AUT"
}]
}],
"who" : {
"reference" : "Practitioner/f202",
"display" : "Luigi Maas"
}
}],
"signature" : [{
"type" : [{
"system" : "urn:iso-astm:E1762-95:2013",
"code" : "1.2.840.10065.1.12.1.1",
"display" : "Author's Signature"
}],
"when" : "2016-10-31T08:25:05+10:00",
"who" : {
"reference" : "Practitioner/example",
"display" : "Dr Adam Careful"
},
"targetFormat" : "application/fhir+xml",
"sigFormat" : "application/signature+xml",
"data" : "dGhpcyBibG9iIGlzIHNuaXBwZWQ="
}]
}],
"identifier" : [{
"use" : "official",
"system" : "http:/goodhealth.org/identifiers",
"value" : "20170201-001"
}],
"basedOn" : [{
"display" : "General Wellness Careplan"
}],
"groupIdentifier" : {
"use" : "official",
"system" : "http:/goodhealth.org/accession/identifiers",
"value" : "G20170201-001"
},
"status": "in-progress",
"businessStatus": {
"text": "waiting for specimen"
"status" : "in-progress",
"businessStatus" : {
"text" : "waiting for specimen"
},
"intent": "order",
"priority": "routine",
"code": {
"text": "Lipid Panel"
"intent" : "order",
"priority" : "routine",
"code" : {
"coding" : [{
"system" : "http://hl7.org/fhir/CodeSystem/task-code",
"code" : "fulfill"
}],
"text" : "Lipid Panel"
},
"description": "Create order for getting specimen, Set up inhouse testing, generate order for any sendouts and submit with specimen",
"focus": {
"reference": "ServiceRequest/lipid",
"display": "Lipid Panel Request"
"description" : "Create order for getting specimen, Set up inhouse testing, generate order for any sendouts and submit with specimen",
"focus" : {
"reference" : "ServiceRequest/lipid",
"display" : "Lipid Panel Request"
},
"for": {
"reference": "Patient/example",
"display": "Peter James Chalmers"
"for" : {
"reference" : "Patient/example",
"display" : "Peter James Chalmers"
},
"encounter": {
"reference": "Encounter/example",
"display": "Example In-Patient Encounter"
"encounter" : {
"reference" : "Encounter/example",
"display" : "Example In-Patient Encounter"
},
"executionPeriod": {
"start": "2016-10-31T08:25:05+10:00"
"executionPeriod" : {
"start" : "2016-10-31T08:25:05+10:00"
},
"authoredOn": "2016-10-31T08:25:05+10:00",
"lastModified": "2016-10-31T09:45:05+10:00",
"requester": {
"reference": "Practitioner/example",
"display": "Dr Adam Careful"
"authoredOn" : "2016-10-31T08:25:05+10:00",
"lastModified" : "2016-10-31T09:45:05+10:00",
"requester" : {
"reference" : "Practitioner/example",
"display" : "Dr Adam Careful"
},
"performerType": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/task-performer-type",
"code": "performer",
"display": "Performer"
}
],
"text": "Performer"
"requestedPerformer" : [{
"concept" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "18850004",
"display" : "Laboratory hematologist"
}],
"text" : "Performer"
}
],
"owner": {
"reference": "Organization/1832473e-2fe0-452d-abe9-3cdb9879522f",
"display": "Clinical Laboratory @ Acme Hospital"
},
"reasonCode": {
"text": "The Task.reason should only be included if there is no Task.focus or if it differs from the reason indicated on the focus"
}],
"owner" : {
"reference" : "Organization/1832473e-2fe0-452d-abe9-3cdb9879522f",
"display" : "Clinical Laboratory @ Acme Hospital"
},
"note": [
{
"text": "This is an example to demonstrate using task for actioning a servicerequest and to illustrate how to populate many of the task elements - this is the parent task that will be broken into subtask to grab the specimen and a sendout lab test"
}
],
"relevantHistory": [
{
"reference": "#signature",
"display": "Author's Signature"
"reason" : [{
"concept" : {
"text" : "The Task.reason should only be included if there is no Task.focus or if it differs from the reason indicated on the focus"
}
],
"restriction": {
"repetitions": 1,
"period": {
"end": "2016-11-02T09:45:05+10:00"
}],
"note" : [{
"text" : "This is an example to demonstrate using task for actioning a servicerequest and to illustrate how to populate many of the task elements - this is the parent task that will be broken into subtask to grab the specimen and a sendout lab test"
}],
"relevantHistory" : [{
"reference" : "#signature",
"display" : "Author's Signature"
}],
"restriction" : {
"repetitions" : 1,
"period" : {
"end" : "2016-11-02T09:45:05+10:00"
}
}
}
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.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
hl7.fhir.core#5.0.0-draft-final
generated
on
Sat,
May
28,
2022
12:57+1000.
Wed,
Mar
1,
2023
23:07+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change