Jump to

• Request
• Response

Get a Task resource by ID

get

/fhir/r4/{query_endpoint_alias}/Task/{id}

This path retrieves an individual Task resource by the associated Task ID.

The Task.read scope is required.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• authorization(required): string
  This string contains the credentials to authenticate a consumer to the service. This value should be the OAuth 2.0 bearer token.

Back to Top

Response

Supported Media Types

• application/fhir+json

200 Response

Success.

Headers

• X-Request-Id: string
  Oracle troubleshooting identifier
• opc-request-id: string,
  Oracle troubleshooting identifier

Body ()

Root Schema : Task

Type: object

The Task FHIR resource.

Show Source

• focus: Focus
• id: string
  The logical ID of this artifact.
• input: array input
  A list of inputs that allow additional custom fields for gathering claim data.
• intent: string
  unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
• resourceType: string
  The resource type is DocumentReference.
• status: string
  draft | requested | received | accepted | +

{
    "description":"The Task FHIR resource.",
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"The resource type is DocumentReference."
        },
        "id":{
            "type":"string",
            "description":"The logical ID of this artifact."
        },
        "status":{
            "type":"string",
            "description":"draft | requested | received | accepted | +"
        },
        "intent":{
            "type":"string",
            "description":"unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option"
        },
        "focus":{
            "$ref":"#/definitions/Focus"
        },
        "input":{
            "description":"A list of inputs that allow additional custom fields for gathering claim data.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Input"
            }
        }
    },
    "example":"{\n  \"resourceType\": \"Task\",\n  \"id\": \"1066\",\n  \"status\": \"completed\",\n  \"intent\": \"unknown\",\n  \"focus\": {\n    \"reference\": \"Claim/62909716\"\n  },\n  \"output\": [\n    {\n      \"type\": {\n        \"coding\": [\n          {\n            \"code\": \"patient\",\n            \"display\": \"patient\"\n          }\n        ],\n        \"text\": \"Patient\"\n      },\n      \"valueReference\": {\n        \"reference\": \"Patient/12621991\",\n        \"identifier\": {\n          \"system\": \"891c71549f4a4bb439b4de8a532f155c_2.16.840.1.113883.3.995.10.1.1\",\n          \"value\": \"6696\"\n        }\n      }\n    },\n    {\n      \"type\": {\n        \"coding\": [\n          {\n            \"code\": \"encounter\",\n            \"display\": \"encounter\"\n          }\n        ],\n        \"text\": \"Encounter\"\n      },\n      \"valueReference\": {\n        \"reference\": \"https://fhir-ehr.sandboxcerner.com/r4/dacc6494-e336-45ad-8729-b789ff8663c6/Encounter/97841466\",\n        \"type\": \"Encounter\",\n        \"identifier\": {\n          \"system\": \"891c71549f4a4bb439b4de8a532f155c_2.16.840.1.113883.3.995.10.2.1\",\n          \"value\": \"15269\"\n        }\n      }\n    },\n    {\n      \"type\": {\n        \"coding\": [\n          {\n            \"code\": \"binary\",\n            \"display\": \"binary\"\n          }\n        ],\n        \"text\": \"Binary\"\n      },\n      \"valueAttachment\": {\n        \"contentType\": \"application/xml\",\n        \"language\": \"en-us\",\n        \"data\": \"<base64Binary>\",\n        \"url\": \"https://cell1.query.stage.cdexhub.us-ashburn-1.oci.oraclecloud.com/fhir/r4/{{queryEndpointAlias}}/Binary/urn:uuid:9a30e4f6-681f-325f-a5e0-456f980da169\",\n        \"size\": 34162,\n        \"hash\": \"d37ec08d5b2c41667b07a94784f45b94c7a2b557\",\n        \"creation\": \"2025-06-27T20:05:14Z\"\n      }\n    }\n  ]\n}\n"
}

Example:

{
  "resourceType": "Task",
  "id": "1066",
  "status": "completed",
  "intent": "unknown",
  "focus": {
    "reference": "Claim/62909716"
  },
  "output": [
    {
      "type": {
        "coding": [
          {
            "code": "patient",
            "display": "patient"
          }
        ],
        "text": "Patient"
      },
      "valueReference": {
        "reference": "Patient/12621991",
        "identifier": {
          "system": "891c71549f4a4bb439b4de8a532f155c_2.16.840.1.113883.3.995.10.1.1",
          "value": "6696"
        }
      }
    },
    {
      "type": {
        "coding": [
          {
            "code": "encounter",
            "display": "encounter"
          }
        ],
        "text": "Encounter"
      },
      "valueReference": {
        "reference": "https://fhir-ehr.sandboxcerner.com/r4/dacc6494-e336-45ad-8729-b789ff8663c6/Encounter/97841466",
        "type": "Encounter",
        "identifier": {
          "system": "891c71549f4a4bb439b4de8a532f155c_2.16.840.1.113883.3.995.10.2.1",
          "value": "15269"
        }
      }
    },
    {
      "type": {
        "coding": [
          {
            "code": "binary",
            "display": "binary"
          }
        ],
        "text": "Binary"
      },
      "valueAttachment": {
        "contentType": "application/xml",
        "language": "en-us",
        "data": "<base64Binary>",
        "url": "https://cell1.query.stage.cdexhub.us-ashburn-1.oci.oraclecloud.com/fhir/r4/{{queryEndpointAlias}}/Binary/urn:uuid:9a30e4f6-681f-325f-a5e0-456f980da169",
        "size": 34162,
        "hash": "d37ec08d5b2c41667b07a94784f45b94c7a2b557",
        "creation": "2025-06-27T20:05:14Z"
      }
    }
  ]
}

Nested Schema : Focus

Match All

Show Source

• object Element
• object Focus-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/Element"
        },
        {
            "type":"object",
            "properties":{
                "reference":{
                    "description":"Reference to another resource",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : input

Type: array

A list of inputs that allow additional custom fields for gathering claim data.

Show Source

• Array of: Input

{
    "description":"A list of inputs that allow additional custom fields for gathering claim data.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Input"
    }
}

Nested Schema : Element

Type: object

Show Source

• extension: array extension
• id: string
  Unique id for inter-element referencing

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique id for inter-element referencing"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Extension"
            }
        }
    }
}

Nested Schema : Focus-allOf[1]

Type: object

Show Source

• reference: string
  Reference to another resource

{
    "type":"object",
    "properties":{
        "reference":{
            "description":"Reference to another resource",
            "type":"string"
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object Extension

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Extension"
    }
}

Nested Schema : Extension

Type: object

Show Source

• url: string
  Minimum Length: 1

  identifies the meaning of the extension
• value: string
  Minimum Length: 1

  Value of extension

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"identifies the meaning of the extension",
            "minLength":1
        },
        "value":{
            "type":"string",
            "description":"Value of extension",
            "minLength":1
        }
    }
}

Nested Schema : Input

Match All

Show Source

• object Element
• object Input-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/Element"
        },
        {
            "type":"object",
            "properties":{
                "type":{
                    "$ref":"#/definitions/Type"
                },
                "valueId":{
                    "description":"Value identifier",
                    "type":"string"
                },
                "valueBoolean":{
                    "description":"Value Boolean",
                    "type":"boolean"
                }
            }
        }
    ]
}

Nested Schema : Input-allOf[1]

Type: object

Show Source

• type: Type
• valueBoolean: boolean
  Value Boolean
• valueId: string
  Value identifier

{
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/definitions/Type"
        },
        "valueId":{
            "description":"Value identifier",
            "type":"string"
        },
        "valueBoolean":{
            "description":"Value Boolean",
            "type":"boolean"
        }
    }
}

Nested Schema : Type

Match All

Show Source

• object Element
• object Type-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/Element"
        },
        {
            "type":"object",
            "properties":{
                "coding":{
                    "description":"Coding system",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/Coding"
                    }
                },
                "text":{
                    "description":"Human-readable text",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : Type-allOf[1]

Type: object

Show Source

• coding: array coding
  Coding system
• text: string
  Human-readable text

{
    "type":"object",
    "properties":{
        "coding":{
            "description":"Coding system",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Coding"
            }
        },
        "text":{
            "description":"Human-readable text",
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Coding system

Show Source

• Array of: Coding

{
    "description":"Coding system",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Coding"
    }
}

Nested Schema : Coding

Match All

Show Source

• object Element
• object Coding-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/Element"
        },
        {
            "type":"object",
            "properties":{
                "system":{
                    "type":"string",
                    "description":"Identity of the terminology system",
                    "minLength":1
                },
                "version":{
                    "type":"string",
                    "description":"Version of the system - if relevant",
                    "minLength":1
                },
                "code":{
                    "type":"string",
                    "description":"Symbol in syntax defined by the system",
                    "minLength":1
                },
                "display":{
                    "type":"string",
                    "description":"Representation defined by the system",
                    "minLength":1
                },
                "userSelected":{
                    "type":"boolean",
                    "description":"If this coding was chosen directly by the user"
                }
            }
        }
    ]
}

Nested Schema : Coding-allOf[1]

Type: object

Show Source

• code: string
  Minimum Length: 1

  Symbol in syntax defined by the system
• display: string
  Minimum Length: 1

  Representation defined by the system
• system: string
  Minimum Length: 1

  Identity of the terminology system
• userSelected: boolean
  If this coding was chosen directly by the user
• version: string
  Minimum Length: 1

  Version of the system - if relevant

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"Identity of the terminology system",
            "minLength":1
        },
        "version":{
            "type":"string",
            "description":"Version of the system - if relevant",
            "minLength":1
        },
        "code":{
            "type":"string",
            "description":"Symbol in syntax defined by the system",
            "minLength":1
        },
        "display":{
            "type":"string",
            "description":"Representation defined by the system",
            "minLength":1
        },
        "userSelected":{
            "type":"boolean",
            "description":"If this coding was chosen directly by the user"
        }
    }
}

401 Response

Authorization information is missing or invalid.

403 Response

The user does not have sufficient access to perform this action.

404 Response

The requested resource was not found. This occurs when the resource is tried to retrieve after cached time (24 hours).

500 Response

Internal Server error.

Back to Top