Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - 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

Example CodeSystem/transport-code (JSON)

Orders and Observations Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Code SystemTransportCode

{
  "resourceType" : "CodeSystem",
  "id" : "transport-code",
  "meta" : {
    "lastUpdated" : "2022-09-10T04:52:37.223+10:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system <code>http://hl7.org/fhir/CodeSystem/transport-code</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">approve<a name=\"transport-code-approve\"> </a></td><td>Activate/approve the focal resource</td><td>Take what actions are needed to transition the focus resource from 'draft' to 'active' or 'in-progress', as appropriate for the resource type.  This may involve additing additional content, approval, validation, etc.</td></tr><tr><td style=\"white-space:nowrap\">fulfill<a name=\"transport-code-fulfill\"> </a></td><td>Fulfill the focal request</td><td>Act to perform the actions described in the focus request.  This might result in a 'more assertive' request (order for a plan or proposal, filler order for a placer order), but is intend to eventually result in events.  The degree of fulfillment requested might be limited by Task.restriction.</td></tr><tr><td style=\"white-space:nowrap\">instantiate<a name=\"transport-code-instantiate\"> </a></td><td>Instantiate the focal definition</td><td>Act to perform the actions defined in the focus definition resource (ActivityDefinition, PlanDefinition, Questionnaire, etc.)  For PlanDefinition or ActivityDefinition, this might result in a 'more assertive' request (order for a plan or proposal, filler order for a placer order), but is intend to eventually result in events.  For Questionnaire, this would result in a QuestionnaireResponse - and possibly resources constructed using data extracted from the response.  The degree of fulfillment requested might be limited by Task.restriction.</td></tr><tr><td style=\"white-space:nowrap\">abort<a name=\"transport-code-abort\"> </a></td><td>Mark the focal resource as no longer active</td><td>Abort, cancel or withdraw the focal resource, as appropriate for the type of resource.</td></tr><tr><td style=\"white-space:nowrap\">replace<a name=\"transport-code-replace\"> </a></td><td>Replace the focal resource with the input resource</td><td>Replace the focal resource with the specified input resource</td></tr><tr><td style=\"white-space:nowrap\">change<a name=\"transport-code-change\"> </a></td><td>Change the focal resource</td><td>Update the focal resource of the owning system to reflect the content specified as the Task.focus</td></tr><tr><td style=\"white-space:nowrap\">suspend<a name=\"transport-code-suspend\"> </a></td><td>Suspend the focal resource</td><td>Transition the focal resource from 'active' or 'in-progress' to 'suspended'</td></tr><tr><td style=\"white-space:nowrap\">resume<a name=\"transport-code-resume\"> </a></td><td>Re-activate the focal resource</td><td>Transition the focal resource from 'suspended' to 'active' or 'in-progress' as appropriate for the resource type.</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "oo"
  }],
  "url" : "http://hl7.org/fhir/CodeSystem/transport-code",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.1931"
  }],
  "version" : "5.0.0-ballot",
  "name" : "TransportCode",
  "title" : "Transport Codes",
  "status" : "active",
  "experimental" : false,
  "description" : "Codes indicating the type of action that is expected to be performed",
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/transport-code.html",
  "content" : "complete",
  "concept" : [{
    "code" : "approve",
    "display" : "Activate/approve the focal resource",
    "definition" : "Take what actions are needed to transition the focus resource from 'draft' to 'active' or 'in-progress', as appropriate for the resource type.  This may involve additing additional content, approval, validation, etc."
  },
  {
    "code" : "fulfill",
    "display" : "Fulfill the focal request",
    "definition" : "Act to perform the actions described in the focus request.  This might result in a 'more assertive' request (order for a plan or proposal, filler order for a placer order), but is intend to eventually result in events.  The degree of fulfillment requested might be limited by Task.restriction."
  },
  {
    "code" : "instantiate",
    "display" : "Instantiate the focal definition",
    "definition" : "Act to perform the actions defined in the focus definition resource (ActivityDefinition, PlanDefinition, Questionnaire, etc.)  For PlanDefinition or ActivityDefinition, this might result in a 'more assertive' request (order for a plan or proposal, filler order for a placer order), but is intend to eventually result in events.  For Questionnaire, this would result in a QuestionnaireResponse - and possibly resources constructed using data extracted from the response.  The degree of fulfillment requested might be limited by Task.restriction."
  },
  {
    "code" : "abort",
    "display" : "Mark the focal resource as no longer active",
    "definition" : "Abort, cancel or withdraw the focal resource, as appropriate for the type of resource."
  },
  {
    "code" : "replace",
    "display" : "Replace the focal resource with the input resource",
    "definition" : "Replace the focal resource with the specified input resource"
  },
  {
    "code" : "change",
    "display" : "Change the focal resource",
    "definition" : "Update the focal resource of the owning system to reflect the content specified as the Task.focus"
  },
  {
    "code" : "suspend",
    "display" : "Suspend the focal resource",
    "definition" : "Transition the focal resource from 'active' or 'in-progress' to 'suspended'"
  },
  {
    "code" : "resume",
    "display" : "Re-activate the focal resource",
    "definition" : "Transition the focal resource from 'suspended' to 'active' or 'in-progress' as appropriate for the resource type."
  }]
}

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.