Jump to

• Request
• Response

Get an asynchronous Task by ID

get

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

This path retrieves a Task by ID so the client can check processing status and read completed output.

Task statuses are requested, accepted, in-progress, on-hold, completed, failed, and rejected. When processing is paused or requires additional internal work, the Task may include businessStatus. When processing is complete, the Task includes output references to contained resources. When the Task status is failed or rejected, the Task includes statusReason.

For completed DocumentReference search Tasks, output may include DocumentReference and OperationOutcome resources.

When a Task is still processing, use the Retry-After response header, when present, as the minimum wait before polling again. Completed Task output is available during the service retention period. The Expires response header indicates the availability expiry when provided. After retention expires, this path may return a 404 (Not Found) status code.

Request

Path Parameters

• id(required): string

  The logical Task 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

• Expires: string
  Date and time after which the Task resource or completed Task output may no longer be available (when known).
• Retry-After: integer
  Minimum number of seconds the client should wait before polling again. This header is returned when the Task is still processing.
• X-Request-Id: string
  Oracle troubleshooting identifier.
• opc-request-id: string
  Oracle troubleshooting identifier.

Body ()

Root Schema : Task

Type: object

The Task FHIR resource used to submit and retrieve asynchronous operation status and output.

Show Source

• authoredOn(required): string(date-time)
  The date and time the Task was created.
• basedOn: array basedOn
  The authorization, order, or request that this Task is fulfilling.
• businessStatus: TaskBusinessStatus
  The business progress for the current Task status.
• code(required): CodeableConcept
• contained: array contained
  The resources included only when Task processing is completed. For the currently supported DocumentReference search, this may include DocumentReference and OperationOutcome resources.
• executionPeriod: Period
• for(required): Reference
• id: string
  The logical ID of this Task.
• identifier: array identifier
  The business identifiers assigned to this Task.
• input(required): array input
  The Task input for the requested operation. The valueString contains the FHIR search criteria and identifies the resource being queried. Currently, only DocumentReference search strings are supported.
• intent(required): string
  Allowed Values: [ "order" ]

  The Task intent. The supported value is order.
• lastModified: string(date-time)
  The date and time the Task was last updated.
• meta: object Meta
  The metadata about a FHIR resource.
• output: array output
  The references to contained resources. This is included only when Task processing is completed.
• owner(required): Reference
• reasonCode: TaskReasonCode
  The reason the requested information is needed. When reasonCode is present, Clinical Data Exchange requires text.
• reasonReference: Reference
• requester(required): Reference
• resourceType(required): string
  The resource type is Task.
• status(required): string
  Allowed Values: [ "requested", "accepted", "in-progress", "on-hold", "completed", "failed", "rejected" ]

  • requested
  • accepted
  • in-progress
  • on-hold
  • completed
  • failed
  • rejected

  Submitted Tasks use requested. Accepted Tasks include the Task ID and basic details. On-hold Tasks may include businessStatus. Completed Tasks include output when available. Failed and rejected Tasks include statusReason.
• statusReason: TaskStatusReason
  The reason the Task was not completed. Required when Task.status is failed or rejected.

{
    "description":"The Task FHIR resource used to submit and retrieve asynchronous operation status and output.",
    "type":"object",
    "required":[
        "resourceType",
        "status",
        "intent",
        "code",
        "for",
        "authoredOn",
        "requester",
        "owner",
        "input"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"The resource type is Task."
        },
        "meta":{
            "$ref":"#/definitions/Meta"
        },
        "id":{
            "type":"string",
            "description":"The logical ID of this Task."
        },
        "identifier":{
            "type":"array",
            "description":"The business identifiers assigned to this Task.",
            "items":{
                "$ref":"#/definitions/Identifier"
            }
        },
        "basedOn":{
            "type":"array",
            "description":"The authorization, order, or request that this Task is fulfilling.",
            "items":{
                "$ref":"#/definitions/Reference"
            }
        },
        "status":{
            "type":"string",
            "description":"<ul> <li><code>requested</code></li> <li><code>accepted</code></li> <li><code>in-progress</code></li> <li><code>on-hold</code></li> <li><code>completed</code></li> <li><code>failed</code></li> <li><code>rejected</code></li> </ul>\nSubmitted Tasks use <code>requested</code>. Accepted Tasks include the Task ID and basic details. On-hold Tasks may include <code>businessStatus</code>. Completed Tasks include output when available. Failed and rejected Tasks include <code>statusReason</code>.",
            "enum":[
                "requested",
                "accepted",
                "in-progress",
                "on-hold",
                "completed",
                "failed",
                "rejected"
            ]
        },
        "statusReason":{
            "$ref":"#/definitions/TaskStatusReason"
        },
        "intent":{
            "type":"string",
            "description":"The Task intent. The supported value is <code>order</code>.",
            "enum":[
                "order"
            ]
        },
        "code":{
            "$ref":"#/definitions/CodeableConcept"
        },
        "for":{
            "$ref":"#/definitions/Reference"
        },
        "authoredOn":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the Task was created."
        },
        "lastModified":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the Task was last updated."
        },
        "businessStatus":{
            "$ref":"#/definitions/TaskBusinessStatus"
        },
        "requester":{
            "$ref":"#/definitions/Reference"
        },
        "owner":{
            "$ref":"#/definitions/Reference"
        },
        "reasonCode":{
            "$ref":"#/definitions/TaskReasonCode"
        },
        "reasonReference":{
            "$ref":"#/definitions/Reference"
        },
        "executionPeriod":{
            "$ref":"#/definitions/Period"
        },
        "input":{
            "type":"array",
            "description":"The Task input for the requested operation. The <code>valueString</code> contains the FHIR search criteria and identifies the resource being queried. Currently, only DocumentReference search strings are supported.",
            "items":{
                "$ref":"#/definitions/TaskInput"
            }
        },
        "contained":{
            "type":"array",
            "description":"The resources included only when Task processing is completed. For the currently supported DocumentReference search, this may include DocumentReference and OperationOutcome resources.",
            "items":{
                "$ref":"#/definitions/TaskContainedResource"
            }
        },
        "output":{
            "type":"array",
            "description":"The references to contained resources. This is included only when Task processing is completed.",
            "items":{
                "$ref":"#/definitions/TaskOutput"
            }
        }
    },
    "example":"{\n  \"resourceType\": \"Task\",\n  \"meta\": {\n    \"profile\": [\n      \"http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request\"\n    ]\n  },\n  \"id\": \"task-123\",\n  \"identifier\": [\n    {\n      \"system\": \"http://example.org/cdex/payer/task-ids\",\n      \"value\": \"<masked-client-task-id>\"\n    }\n  ],\n  \"basedOn\": [\n    {\n      \"type\": \"ServiceRequest\",\n      \"identifier\": {\n        \"system\": \"http://example.org/cdex/payer/authorization-ids\",\n        \"value\": \"<masked-authorization-id>\"\n      },\n      \"display\": \"[MASKED_AUTHORIZATION]\"\n    }\n  ],\n  \"status\": \"completed\",\n  \"intent\": \"order\",\n  \"code\": {\n    \"coding\": [\n      {\n        \"system\": \"http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp\",\n        \"code\": \"data-request-query\",\n        \"display\": \"Data Request Query\"\n      }\n    ]\n  },\n  \"for\": {\n    \"identifier\": {\n      \"type\": {\n        \"coding\": [\n          {\n            \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0203\",\n            \"code\": \"MB\",\n            \"display\": \"Member Number\"\n          }\n        ],\n        \"text\": \"Member Number\"\n      },\n      \"system\": \"http://example.org/cdex/payer/member-ids\",\n      \"value\": \"<masked-member-id>\"\n    },\n    \"display\": \"[MASKED_MEMBER]\"\n  },\n  \"authoredOn\": \"2026-07-07T18:30:00Z\",\n  \"lastModified\": \"2026-07-07T18:35:00Z\",\n  \"businessStatus\": {\n    \"text\": \"Completed\"\n  },\n  \"requester\": {\n    \"identifier\": {\n      \"system\": \"http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization\",\n      \"value\": \"PayerName\"\n    },\n    \"display\": \"PayerName\"\n  },\n  \"owner\": {\n    \"identifier\": {\n      \"system\": \"https://cell1.query.cdexhub.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/owner-name\",\n      \"value\": \"Oracle Health Clinical Data Exchange\"\n    },\n    \"display\": \"Oracle Health Clinical Data Exchange\"\n  },\n  \"reasonCode\": {\n    \"text\": \"Claims processing\"\n  },\n  \"reasonReference\": {\n    \"type\": \"Claim\",\n    \"identifier\": {\n      \"type\": {\n        \"coding\": [\n          {\n            \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0203\",\n            \"code\": \"FILL\",\n            \"display\": \"Filler Identifier\"\n          }\n        ],\n        \"text\": \"Payer claim identifier\"\n      },\n      \"system\": \"http://example.org/cdex/payer/claim-ids\",\n      \"value\": \"<masked-claim-id>\"\n    },\n    \"display\": \"[MASKED_CLAIM]\"\n  },\n  \"input\": [\n    {\n      \"type\": {\n        \"coding\": [\n          {\n            \"system\": \"http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp\",\n            \"code\": \"data-query\",\n            \"display\": \"data query input\"\n          }\n        ],\n        \"text\": \"DocumentReference search request\"\n      },\n      \"valueString\": \"DocumentReference?patient=<masked-patient-id>&date=ge2024-07-15&date=le2025-08-08\"\n    }\n  ],\n  \"contained\": [\n    {\n      \"resourceType\": \"DocumentReference\",\n      \"id\": \"docref-1\",\n      \"meta\": {\n        \"versionId\": \"1\",\n        \"lastUpdated\": \"2026-01-01T09:00:00.000Z\"\n      },\n      \"text\": {\n        \"status\": \"generated\",\n        \"div\": \"<div xmlns=\\\"http://www.w3.org/1999/xhtml\\\"><p><b>Document Reference</b></p><p><b>Patient Name</b>: [MASKED]</p><p><b>Document Type</b>: [MASKED_DOCUMENT_TYPE]</p><p><b>Document Category</b>: [MASKED]</p><p><b>Document Title</b>: [MASKED_DOCUMENT_TITLE]</p><p><b>Service Start Date</b>: [MASKED_DATE]</p><p><b>Service End Date</b>: [MASKED_DATE]</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: [MASKED]</p></div>\"\n      },\n      \"masterIdentifier\": {\n        \"system\": \"urn:ietf:rfc:3986\",\n        \"value\": \"2.25.<masked-document-identifier>\"\n      },\n      \"identifier\": [\n        {\n          \"use\": \"official\",\n          \"system\": \"urn:ietf:rfc:3986\",\n          \"value\": \"urn:uuid:00000000-0000-4000-8000-000000000001\"\n        },\n        {\n          \"system\": \"https://fhir.cerner.com/ceuuid\",\n          \"value\": \"<masked-document-identifier>\"\n        }\n      ],\n      \"status\": \"current\",\n      \"docStatus\": \"final\",\n      \"type\": {\n        \"coding\": [\n          {\n            \"system\": \"https://fhir.cerner.com/{tenant-id}/codeSet/72\",\n            \"code\": \"<masked-document-type-code>\",\n            \"display\": \"[MASKED_DOCUMENT_TYPE]\",\n            \"userSelected\": true\n          },\n          {\n            \"system\": \"http://terminology.hl7.org/CodeSystem/v3-NullFlavor\",\n            \"code\": \"UNK\",\n            \"display\": \"unknown\"\n          }\n        ],\n        \"text\": \"[MASKED_DOCUMENT_TYPE]\"\n      },\n      \"category\": [\n        {\n          \"coding\": [\n            {\n              \"system\": \"http://terminology.hl7.org/CodeSystem/data-absent-reason\",\n              \"code\": \"unknown\",\n              \"display\": \"Unknown\"\n            }\n          ],\n          \"text\": \"Unknown\"\n        }\n      ],\n      \"subject\": {\n        \"reference\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/fhir/r4/{query_endpoint_alias}/Patient/<masked-patient-id>\",\n        \"display\": \"[MASKED_PATIENT_NAME]\"\n      },\n      \"date\": \"2026-01-01T14:00:00.000Z\",\n      \"author\": [\n        {\n          \"type\": \"Practitioner\",\n          \"identifier\": {\n            \"use\": \"usual\",\n            \"type\": {\n              \"coding\": [\n                {\n                  \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0203\",\n                  \"code\": \"NPI\",\n                  \"display\": \"National provider identifier\"\n                }\n              ],\n              \"text\": \"National Provider Identifier\"\n            },\n            \"system\": \"http://hl7.org/fhir/sid/us-npi\",\n            \"value\": \"<masked-provider-npi>\",\n            \"period\": {\n              \"start\": \"2020-01-01T00:00:00Z\"\n            }\n          },\n          \"display\": \"[MASKED_PROVIDER_NAME]\"\n        }\n      ],\n      \"authenticator\": {\n        \"type\": \"Practitioner\",\n        \"identifier\": {\n          \"use\": \"usual\",\n          \"type\": {\n            \"coding\": [\n              {\n                \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0203\",\n                \"code\": \"NPI\",\n                \"display\": \"National provider identifier\"\n              }\n            ],\n            \"text\": \"National Provider Identifier\"\n          },\n          \"system\": \"http://hl7.org/fhir/sid/us-npi\",\n          \"value\": \"<masked-provider-npi>\",\n          \"period\": {\n            \"start\": \"2020-01-01T00:00:00Z\"\n          }\n        },\n        \"display\": \"[MASKED_PROVIDER_NAME]\"\n      },\n      \"custodian\": {\n        \"type\": \"Organization\",\n        \"identifier\": {\n          \"extension\": [\n            {\n              \"url\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/facility-npi\",\n              \"valueString\": \"<masked-facility-npi>\"\n            },\n            {\n              \"url\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/facility-tin\",\n              \"valueString\": \"<masked-facility-tin>\"\n            }\n          ],\n          \"use\": \"official\",\n          \"type\": {\n            \"coding\": [\n              {\n                \"system\": \"https://fhir.cerner.com/{tenant-id}/codeSet/334\",\n                \"code\": \"OID\",\n                \"display\": \"OID\",\n                \"userSelected\": true\n              },\n              {\n                \"system\": \"urn:ietf:rfc:3986\",\n                \"code\": \"urn:oid\",\n                \"display\": \"OID\"\n              }\n            ],\n            \"text\": \"OID\"\n          },\n          \"system\": \"urn:ietf:rfc:3986\",\n          \"value\": \"urn:oid:<masked-organization-oid>\"\n        },\n        \"display\": \"[MASKED_ORGANIZATION_NAME]\"\n      },\n      \"description\": \"[MASKED_DOCUMENT_TITLE]\",\n      \"securityLabel\": [\n        {\n          \"coding\": [\n            {\n              \"system\": \"2.16.840.1.113883.5.25\",\n              \"code\": \"N\",\n              \"display\": \"Normal\"\n            }\n          ]\n        }\n      ],\n      \"content\": [\n        {\n          \"attachment\": {\n            \"contentType\": \"application/xml\",\n            \"language\": \"en\",\n            \"url\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/fhir/r4/{query_endpoint_alias}/Binary/urn:uuid:00000000-0000-4000-8000-000000000001\",\n            \"creation\": \"2026-01-01T14:00:00Z\"\n          },\n          \"format\": {\n            \"system\": \"http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem\",\n            \"code\": \"urn:hl7-org:sdwg:ccda-nonXMLBody:2.1\",\n            \"display\": \"Non Structured C-CDA 2.1\"\n          }\n        }\n      ],\n      \"context\": {\n        \"encounter\": [\n          {\n            \"extension\": [\n              {\n                \"url\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/encounter-last-updated-datetime\",\n                \"valueDateTime\": \"2026-01-01T21:00:00Z\"\n              },\n              {\n                \"url\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/encounter-start-datetime\",\n                \"valueDateTime\": \"2026-01-01T13:00:00Z\"\n              },\n              {\n                \"url\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/encounter-end-datetime\",\n                \"valueDateTime\": \"2026-01-01T15:00:00Z\"\n              },\n              {\n                \"url\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/encounter-class\",\n                \"valueCodeableConcept\": {\n                  \"coding\": [\n                    {\n                      \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n                      \"code\": \"<masked-encounter-class-code>\",\n                      \"display\": \"[MASKED_ENCOUNTER_CLASS]\"\n                    }\n                  ]\n                }\n              },\n              {\n                \"url\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/encounter-type\",\n                \"valueCodeableConcept\": {\n                  \"coding\": [\n                    {\n                      \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0004\",\n                      \"code\": \"<masked-encounter-type-code>\",\n                      \"display\": \"[MASKED_ENCOUNTER_TYPE]\"\n                    }\n                  ]\n                }\n              }\n            ],\n            \"identifier\": {\n              \"system\": \"<masked-encounter-system>\",\n              \"value\": \"<masked-encounter-id>\"\n            }\n          }\n        ],\n        \"period\": {\n          \"start\": \"2026-01-01T14:00:00Z\",\n          \"end\": \"2026-01-01T14:00:00Z\"\n        },\n        \"sourcePatientInfo\": {\n          \"identifier\": {\n            \"system\": \"<masked-source-patient-system>\",\n            \"value\": \"<masked-source-patient-id>\"\n          },\n          \"display\": \"[MASKED_SOURCE_PATIENT_INFO]\"\n        }\n      }\n    },\n    {\n      \"resourceType\": \"DocumentReference\",\n      \"id\": \"docref-2\",\n      \"meta\": {\n        \"versionId\": \"1\",\n        \"lastUpdated\": \"2026-01-01T10:00:00.000Z\"\n      },\n      \"status\": \"current\",\n      \"docStatus\": \"final\",\n      \"type\": {\n        \"coding\": [\n          {\n            \"system\": \"https://fhir.cerner.com/{tenant-id}/codeSet/72\",\n            \"code\": \"<masked-document-type-code>\",\n            \"display\": \"[MASKED_DOCUMENT_TYPE]\",\n            \"userSelected\": true\n          }\n        ],\n        \"text\": \"[MASKED_DOCUMENT_TYPE]\"\n      },\n      \"subject\": {\n        \"reference\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/fhir/r4/{query_endpoint_alias}/Patient/<masked-patient-id>\",\n        \"display\": \"[MASKED_PATIENT_NAME]\"\n      },\n      \"date\": \"2026-01-01T15:00:00.000Z\",\n      \"description\": \"[MASKED_DOCUMENT_TITLE]\",\n      \"content\": [\n        {\n          \"attachment\": {\n            \"contentType\": \"application/xml\",\n            \"language\": \"en\",\n            \"url\": \"https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/fhir/r4/{query_endpoint_alias}/Binary/urn:uuid:00000000-0000-4000-8000-000000000002\",\n            \"creation\": \"2026-01-01T15:00:00Z\"\n          },\n          \"format\": {\n            \"system\": \"http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem\",\n            \"code\": \"urn:hl7-org:sdwg:ccda-nonXMLBody:2.1\",\n            \"display\": \"Non Structured C-CDA 2.1\"\n          }\n        }\n      ],\n      \"context\": {\n        \"period\": {\n          \"start\": \"2026-01-01T15:00:00Z\",\n          \"end\": \"2026-01-01T15:00:00Z\"\n        }\n      }\n    },\n    {\n      \"resourceType\": \"OperationOutcome\",\n      \"id\": \"outcome-1\",\n      \"issue\": [\n        {\n          \"severity\": \"information\",\n          \"code\": \"informational\",\n          \"details\": {\n            \"text\": \"No Payer were resolved for given patient <masked-patient-identifier>\"\n          }\n        },\n        {\n          \"severity\": \"information\",\n          \"code\": \"informational\",\n          \"details\": {\n            \"text\": \"No encounters were qualified for given date range and patient <masked-patient-identifier>\"\n          }\n        }\n      ]\n    }\n  ],\n  \"output\": [\n    {\n      \"type\": {\n        \"coding\": [\n          {\n            \"system\": \"http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp\",\n            \"code\": \"data-value\",\n            \"display\": \"data values output\"\n          }\n        ],\n        \"text\": \"DocumentReference result\"\n      },\n      \"valueReference\": {\n        \"reference\": \"#docref-1\"\n      }\n    },\n    {\n      \"type\": {\n        \"coding\": [\n          {\n            \"system\": \"http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp\",\n            \"code\": \"data-value\",\n            \"display\": \"data values output\"\n          }\n        ],\n        \"text\": \"DocumentReference result\"\n      },\n      \"valueReference\": {\n        \"reference\": \"#docref-2\"\n      }\n    },\n    {\n      \"type\": {\n        \"coding\": [\n          {\n            \"system\": \"http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp\",\n            \"code\": \"data-value\",\n            \"display\": \"data values output\"\n          }\n        ],\n        \"text\": \"OperationOutcome result\"\n      },\n      \"valueReference\": {\n        \"reference\": \"#outcome-1\"\n      }\n    }\n  ]\n}\n"
}

Example:

{
  "resourceType": "Task",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
    ]
  },
  "id": "task-123",
  "identifier": [
    {
      "system": "http://example.org/cdex/payer/task-ids",
      "value": "<masked-client-task-id>"
    }
  ],
  "basedOn": [
    {
      "type": "ServiceRequest",
      "identifier": {
        "system": "http://example.org/cdex/payer/authorization-ids",
        "value": "<masked-authorization-id>"
      },
      "display": "[MASKED_AUTHORIZATION]"
    }
  ],
  "status": "completed",
  "intent": "order",
  "code": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp",
        "code": "data-request-query",
        "display": "Data Request Query"
      }
    ]
  },
  "for": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "MB",
            "display": "Member Number"
          }
        ],
        "text": "Member Number"
      },
      "system": "http://example.org/cdex/payer/member-ids",
      "value": "<masked-member-id>"
    },
    "display": "[MASKED_MEMBER]"
  },
  "authoredOn": "2026-07-07T18:30:00Z",
  "lastModified": "2026-07-07T18:35:00Z",
  "businessStatus": {
    "text": "Completed"
  },
  "requester": {
    "identifier": {
      "system": "http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization",
      "value": "PayerName"
    },
    "display": "PayerName"
  },
  "owner": {
    "identifier": {
      "system": "https://cell1.query.cdexhub.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/owner-name",
      "value": "Oracle Health Clinical Data Exchange"
    },
    "display": "Oracle Health Clinical Data Exchange"
  },
  "reasonCode": {
    "text": "Claims processing"
  },
  "reasonReference": {
    "type": "Claim",
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "FILL",
            "display": "Filler Identifier"
          }
        ],
        "text": "Payer claim identifier"
      },
      "system": "http://example.org/cdex/payer/claim-ids",
      "value": "<masked-claim-id>"
    },
    "display": "[MASKED_CLAIM]"
  },
  "input": [
    {
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp",
            "code": "data-query",
            "display": "data query input"
          }
        ],
        "text": "DocumentReference search request"
      },
      "valueString": "DocumentReference?patient=<masked-patient-id>&date=ge2024-07-15&date=le2025-08-08"
    }
  ],
  "contained": [
    {
      "resourceType": "DocumentReference",
      "id": "docref-1",
      "meta": {
        "versionId": "1",
        "lastUpdated": "2026-01-01T09:00:00.000Z"
      },
      "text": {
        "status": "generated",
        "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Document Reference</b></p><p><b>Patient Name</b>: [MASKED]</p><p><b>Document Type</b>: [MASKED_DOCUMENT_TYPE]</p><p><b>Document Category</b>: [MASKED]</p><p><b>Document Title</b>: [MASKED_DOCUMENT_TITLE]</p><p><b>Service Start Date</b>: [MASKED_DATE]</p><p><b>Service End Date</b>: [MASKED_DATE]</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: [MASKED]</p></div>"
      },
      "masterIdentifier": {
        "system": "urn:ietf:rfc:3986",
        "value": "2.25.<masked-document-identifier>"
      },
      "identifier": [
        {
          "use": "official",
          "system": "urn:ietf:rfc:3986",
          "value": "urn:uuid:00000000-0000-4000-8000-000000000001"
        },
        {
          "system": "https://fhir.cerner.com/ceuuid",
          "value": "<masked-document-identifier>"
        }
      ],
      "status": "current",
      "docStatus": "final",
      "type": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/{tenant-id}/codeSet/72",
            "code": "<masked-document-type-code>",
            "display": "[MASKED_DOCUMENT_TYPE]",
            "userSelected": true
          },
          {
            "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
            "code": "UNK",
            "display": "unknown"
          }
        ],
        "text": "[MASKED_DOCUMENT_TYPE]"
      },
      "category": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
              "code": "unknown",
              "display": "Unknown"
            }
          ],
          "text": "Unknown"
        }
      ],
      "subject": {
        "reference": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/fhir/r4/{query_endpoint_alias}/Patient/<masked-patient-id>",
        "display": "[MASKED_PATIENT_NAME]"
      },
      "date": "2026-01-01T14:00:00.000Z",
      "author": [
        {
          "type": "Practitioner",
          "identifier": {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "NPI",
                  "display": "National provider identifier"
                }
              ],
              "text": "National Provider Identifier"
            },
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "<masked-provider-npi>",
            "period": {
              "start": "2020-01-01T00:00:00Z"
            }
          },
          "display": "[MASKED_PROVIDER_NAME]"
        }
      ],
      "authenticator": {
        "type": "Practitioner",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                "code": "NPI",
                "display": "National provider identifier"
              }
            ],
            "text": "National Provider Identifier"
          },
          "system": "http://hl7.org/fhir/sid/us-npi",
          "value": "<masked-provider-npi>",
          "period": {
            "start": "2020-01-01T00:00:00Z"
          }
        },
        "display": "[MASKED_PROVIDER_NAME]"
      },
      "custodian": {
        "type": "Organization",
        "identifier": {
          "extension": [
            {
              "url": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/facility-npi",
              "valueString": "<masked-facility-npi>"
            },
            {
              "url": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/facility-tin",
              "valueString": "<masked-facility-tin>"
            }
          ],
          "use": "official",
          "type": {
            "coding": [
              {
                "system": "https://fhir.cerner.com/{tenant-id}/codeSet/334",
                "code": "OID",
                "display": "OID",
                "userSelected": true
              },
              {
                "system": "urn:ietf:rfc:3986",
                "code": "urn:oid",
                "display": "OID"
              }
            ],
            "text": "OID"
          },
          "system": "urn:ietf:rfc:3986",
          "value": "urn:oid:<masked-organization-oid>"
        },
        "display": "[MASKED_ORGANIZATION_NAME]"
      },
      "description": "[MASKED_DOCUMENT_TITLE]",
      "securityLabel": [
        {
          "coding": [
            {
              "system": "2.16.840.1.113883.5.25",
              "code": "N",
              "display": "Normal"
            }
          ]
        }
      ],
      "content": [
        {
          "attachment": {
            "contentType": "application/xml",
            "language": "en",
            "url": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/fhir/r4/{query_endpoint_alias}/Binary/urn:uuid:00000000-0000-4000-8000-000000000001",
            "creation": "2026-01-01T14:00:00Z"
          },
          "format": {
            "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
            "code": "urn:hl7-org:sdwg:ccda-nonXMLBody:2.1",
            "display": "Non Structured C-CDA 2.1"
          }
        }
      ],
      "context": {
        "encounter": [
          {
            "extension": [
              {
                "url": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/encounter-last-updated-datetime",
                "valueDateTime": "2026-01-01T21:00:00Z"
              },
              {
                "url": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/encounter-start-datetime",
                "valueDateTime": "2026-01-01T13:00:00Z"
              },
              {
                "url": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/encounter-end-datetime",
                "valueDateTime": "2026-01-01T15:00:00Z"
              },
              {
                "url": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/encounter-class",
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                      "code": "<masked-encounter-class-code>",
                      "display": "[MASKED_ENCOUNTER_CLASS]"
                    }
                  ]
                }
              },
              {
                "url": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/r4/StructureDefinition/custom-attribute/encounter-type",
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v2-0004",
                      "code": "<masked-encounter-type-code>",
                      "display": "[MASKED_ENCOUNTER_TYPE]"
                    }
                  ]
                }
              }
            ],
            "identifier": {
              "system": "<masked-encounter-system>",
              "value": "<masked-encounter-id>"
            }
          }
        ],
        "period": {
          "start": "2026-01-01T14:00:00Z",
          "end": "2026-01-01T14:00:00Z"
        },
        "sourcePatientInfo": {
          "identifier": {
            "system": "<masked-source-patient-system>",
            "value": "<masked-source-patient-id>"
          },
          "display": "[MASKED_SOURCE_PATIENT_INFO]"
        }
      }
    },
    {
      "resourceType": "DocumentReference",
      "id": "docref-2",
      "meta": {
        "versionId": "1",
        "lastUpdated": "2026-01-01T10:00:00.000Z"
      },
      "status": "current",
      "docStatus": "final",
      "type": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/{tenant-id}/codeSet/72",
            "code": "<masked-document-type-code>",
            "display": "[MASKED_DOCUMENT_TYPE]",
            "userSelected": true
          }
        ],
        "text": "[MASKED_DOCUMENT_TYPE]"
      },
      "subject": {
        "reference": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/fhir/r4/{query_endpoint_alias}/Patient/<masked-patient-id>",
        "display": "[MASKED_PATIENT_NAME]"
      },
      "date": "2026-01-01T15:00:00.000Z",
      "description": "[MASKED_DOCUMENT_TITLE]",
      "content": [
        {
          "attachment": {
            "contentType": "application/xml",
            "language": "en",
            "url": "https://cell1.query.cdexhub.us-chicago-1.oci.oraclecloud.com/fhir/r4/{query_endpoint_alias}/Binary/urn:uuid:00000000-0000-4000-8000-000000000002",
            "creation": "2026-01-01T15:00:00Z"
          },
          "format": {
            "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
            "code": "urn:hl7-org:sdwg:ccda-nonXMLBody:2.1",
            "display": "Non Structured C-CDA 2.1"
          }
        }
      ],
      "context": {
        "period": {
          "start": "2026-01-01T15:00:00Z",
          "end": "2026-01-01T15:00:00Z"
        }
      }
    },
    {
      "resourceType": "OperationOutcome",
      "id": "outcome-1",
      "issue": [
        {
          "severity": "information",
          "code": "informational",
          "details": {
            "text": "No Payer were resolved for given patient <masked-patient-identifier>"
          }
        },
        {
          "severity": "information",
          "code": "informational",
          "details": {
            "text": "No encounters were qualified for given date range and patient <masked-patient-identifier>"
          }
        }
      ]
    }
  ],
  "output": [
    {
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp",
            "code": "data-value",
            "display": "data values output"
          }
        ],
        "text": "DocumentReference result"
      },
      "valueReference": {
        "reference": "#docref-1"
      }
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp",
            "code": "data-value",
            "display": "data values output"
          }
        ],
        "text": "DocumentReference result"
      },
      "valueReference": {
        "reference": "#docref-2"
      }
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp",
            "code": "data-value",
            "display": "data values output"
          }
        ],
        "text": "OperationOutcome result"
      },
      "valueReference": {
        "reference": "#outcome-1"
      }
    }
  ]
}

Nested Schema : basedOn

Type: array

The authorization, order, or request that this Task is fulfilling.

Show Source

• Array of: Reference

{
    "type":"array",
    "description":"The authorization, order, or request that this Task is fulfilling.",
    "items":{
        "$ref":"#/definitions/Reference"
    }
}

Nested Schema : TaskBusinessStatus

The business progress for the current Task status.

Match All

The business progress for the current Task status.

The business progress for the current Task status.

Show Source

• allOf CodeableConcept
• object TaskBusinessStatus-allOf[1]

{
    "description":"The business progress for the current Task status.",
    "allOf":[
        {
            "$ref":"#/definitions/CodeableConcept"
        },
        {
            "type":"object",
            "required":[
                "text"
            ],
            "properties":{
                "text":{
                    "type":"string",
                    "description":"The human-readable business progress, for example, <code>waiting on internal review</code>."
                }
            }
        }
    ]
}

Nested Schema : CodeableConcept

Match All

Show Source

• object Element
• object CodeableConcept-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/Element"
        },
        {
            "type":"object",
            "properties":{
                "coding":{
                    "description":"A reference to a code defined by a terminology system.",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/Coding"
                    }
                },
                "text":{
                    "type":"string",
                    "description":"The plain text representation of the concept."
                }
            }
        }
    ]
}

Nested Schema : contained

Type: array

The resources included only when Task processing is completed. For the currently supported DocumentReference search, this may include DocumentReference and OperationOutcome resources.

Show Source

• Array of: object TaskContainedResource
  A resource contained in a completed Task output. For the currently supported DocumentReference search, contained resources are DocumentReference or OperationOutcome resources.

{
    "type":"array",
    "description":"The resources included only when Task processing is completed. For the currently supported DocumentReference search, this may include DocumentReference and OperationOutcome resources.",
    "items":{
        "$ref":"#/definitions/TaskContainedResource"
    }
}

Nested Schema : Period

Match All

Show Source

• object Element
• object Period-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/Element"
        },
        {
            "type":"object",
            "properties":{
                "start":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The starting time with an inclusive boundary."
                },
                "end":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The end time with an inclusive boundary."
                }
            }
        }
    ]
}

Nested Schema : Reference

Match All

Show Source

• object Element
• object Reference-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/Element"
        },
        {
            "type":"object",
            "properties":{
                "reference":{
                    "type":"string",
                    "description":"The literal reference, relative, internal or absolute URL."
                },
                "type":{
                    "type":"string",
                    "description":"The type the reference refers to (for example, Patient)."
                },
                "identifier":{
                    "$ref":"#/definitions/Identifier"
                },
                "display":{
                    "type":"string",
                    "description":"The text alternative for the resource."
                }
            }
        }
    ]
}

Nested Schema : identifier

Type: array

The business identifiers assigned to this Task.

Show Source

• Array of: Identifier

{
    "type":"array",
    "description":"The business identifiers assigned to this Task.",
    "items":{
        "$ref":"#/definitions/Identifier"
    }
}

Nested Schema : input

Type: array

The Task input for the requested operation. The valueString contains the FHIR search criteria and identifies the resource being queried. Currently, only DocumentReference search strings are supported.

Show Source

• Array of: TaskInput
  The input parameter for a Task. This endpoint supports the CDEX Task Data Request query pattern. The required query input uses the Da Vinci Health Record Exchange (HRex) data-query code. The resource being queried is identified by the FHIR search string in valueString, for example, DocumentReference?patient=...

{
    "type":"array",
    "description":"The Task input for the requested operation. The <code>valueString</code> contains the FHIR search criteria and identifies the resource being queried. Currently, only DocumentReference search strings are supported.",
    "items":{
        "$ref":"#/definitions/TaskInput"
    }
}

Nested Schema : Meta

Type: object

The metadata about a FHIR resource.

Show Source

• lastUpdated: string(date-time)
  When the resource version last changed.
• profile: array profile
  The profiles this resource claims to conform to.
• versionId: string
  The version-specific identifier.

{
    "description":"The metadata about a FHIR resource.",
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string",
            "description":"The version-specific identifier."
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"When the resource version last changed."
        },
        "profile":{
            "type":"array",
            "description":"The profiles this resource claims to conform to.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : output

Type: array

The references to contained resources. This is included only when Task processing is completed.

Show Source

• Array of: TaskOutput
  The output parameter for a completed Task. Completed search output uses the HRex data-value code.

{
    "type":"array",
    "description":"The references to contained resources. This is included only when Task processing is completed.",
    "items":{
        "$ref":"#/definitions/TaskOutput"
    }
}

Nested Schema : TaskReasonCode

The reason the requested information is needed. When reasonCode is present, Clinical Data Exchange requires text.

Match All

The reason the requested information is needed. When reasonCode is present, Clinical Data Exchange requires text.

The reason the requested information is needed. When reasonCode is present, Clinical Data Exchange requires text.

Show Source

• allOf CodeableConcept
• object TaskReasonCode-allOf[1]

{
    "description":"The reason the requested information is needed. When <code>reasonCode</code> is present, Clinical Data Exchange requires text.",
    "allOf":[
        {
            "$ref":"#/definitions/CodeableConcept"
        },
        {
            "type":"object",
            "required":[
                "text"
            ],
            "properties":{
                "text":{
                    "type":"string",
                    "description":"The human-readable reason the information is being requested."
                }
            }
        }
    ]
}

Nested Schema : TaskStatusReason

The reason the Task was not completed. Required when Task.status is failed or rejected.

Match All

The reason the Task was not completed. Required when Task.status is failed or rejected.

The reason the Task was not completed. Required when Task.status is failed or rejected.

Show Source

• allOf CodeableConcept
• object TaskStatusReason-allOf[1]

{
    "description":"The reason the Task was not completed. Required when <code>Task.status</code> is <code><b>failed</b></code> or <code><b>rejected</b></code>.",
    "allOf":[
        {
            "$ref":"#/definitions/CodeableConcept"
        },
        {
            "type":"object",
            "required":[
                "text"
            ],
            "properties":{
                "text":{
                    "type":"string",
                    "description":"The human-readable reason the Task failed or was rejected."
                }
            }
        }
    ]
}

Nested Schema : Element

Type: object

Show Source

• extension: array extension
• id: string
  The unique ID for inter-element referencing.

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

Nested Schema : CodeableConcept-allOf[1]

Type: object

Show Source

• coding: array coding
  A reference to a code defined by a terminology system.
• text: string
  The plain text representation of the concept.

{
    "type":"object",
    "properties":{
        "coding":{
            "description":"A reference to a code defined by a terminology system.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Coding"
            }
        },
        "text":{
            "type":"string",
            "description":"The plain text representation of the concept."
        }
    }
}

Nested Schema : TaskBusinessStatus-allOf[1]

Type: object

Show Source

• text(required): string
  The human-readable business progress, for example, waiting on internal review.

{
    "type":"object",
    "required":[
        "text"
    ],
    "properties":{
        "text":{
            "type":"string",
            "description":"The human-readable business progress, for example, <code>waiting on internal review</code>."
        }
    }
}

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

  The value of the extension.

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"Identifies the meaning of the extension.",
            "minLength":1
        },
        "value":{
            "type":"string",
            "description":"The value of the extension.",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

A reference to a code defined by a terminology system.

Show Source

• Array of: Coding

{
    "description":"A reference to a code defined by a terminology 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":"The identity of the terminology system.",
                    "minLength":1
                },
                "version":{
                    "type":"string",
                    "description":"The version of the system, if relevant.",
                    "minLength":1
                },
                "code":{
                    "type":"string",
                    "description":"The symbol in syntax defined by the system.",
                    "minLength":1
                },
                "display":{
                    "type":"string",
                    "description":"The 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

  The symbol in syntax defined by the system.
• display: string
  Minimum Length: 1

  The representation defined by the system.
• system: string
  Minimum Length: 1

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

  The version of the system, if relevant.

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"The identity of the terminology system.",
            "minLength":1
        },
        "version":{
            "type":"string",
            "description":"The version of the system, if relevant.",
            "minLength":1
        },
        "code":{
            "type":"string",
            "description":"The symbol in syntax defined by the system.",
            "minLength":1
        },
        "display":{
            "type":"string",
            "description":"The representation defined by the system.",
            "minLength":1
        },
        "userSelected":{
            "type":"boolean",
            "description":"If this coding was chosen directly by the user."
        }
    }
}

Nested Schema : TaskContainedResource

Type: object

A resource contained in a completed Task output. For the currently supported DocumentReference search, contained resources are DocumentReference or OperationOutcome resources.

Show Source

• id: string
  The local contained resource ID referenced by Task.output.valueReference.
• resourceType: string
  Allowed Values: [ "DocumentReference", "OperationOutcome" ]

  The contained resource type.

{
    "description":"A resource contained in a completed Task output. For the currently supported DocumentReference search, contained resources are DocumentReference or OperationOutcome resources.",
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"The contained resource type.",
            "enum":[
                "DocumentReference",
                "OperationOutcome"
            ]
        },
        "id":{
            "type":"string",
            "description":"The local contained resource ID referenced by <code>Task.output.valueReference</code>."
        }
    }
}

Nested Schema : Period-allOf[1]

Type: object

Show Source

• end: string(date-time)
  The end time with an inclusive boundary.
• start: string(date-time)
  The starting time with an inclusive boundary.

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time",
            "description":"The starting time with an inclusive boundary."
        },
        "end":{
            "type":"string",
            "format":"date-time",
            "description":"The end time with an inclusive boundary."
        }
    }
}

Nested Schema : Reference-allOf[1]

Type: object

Show Source

• display: string
  The text alternative for the resource.
• identifier: Identifier
• reference: string
  The literal reference, relative, internal or absolute URL.
• type: string
  The type the reference refers to (for example, Patient).

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string",
            "description":"The literal reference, relative, internal or absolute URL."
        },
        "type":{
            "type":"string",
            "description":"The type the reference refers to (for example, Patient)."
        },
        "identifier":{
            "$ref":"#/definitions/Identifier"
        },
        "display":{
            "type":"string",
            "description":"The text alternative for the resource."
        }
    }
}

Nested Schema : Identifier

Match All

Show Source

• object Element
• object Identifier-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/Element"
        },
        {
            "type":"object",
            "properties":{
                "use":{
                    "type":"string",
                    "description":"<ul> <li><code>usual</code></li> <li><code>official</code></li> <li><code>temp</code></li> <li><code>secondary</code></li> <li><code>old</code> (if known)</li> </ul>"
                },
                "type":{
                    "$ref":"#/definitions/CodeableConcept"
                },
                "system":{
                    "type":"string",
                    "description":"The namespace for the identifier value (URI)."
                },
                "value":{
                    "type":"string",
                    "description":"The value that is unique."
                },
                "period":{
                    "$ref":"#/definitions/Period"
                }
            }
        }
    ]
}

Nested Schema : Identifier-allOf[1]

Type: object

Show Source

• period: Period
• system: string
  The namespace for the identifier value (URI).
• type: CodeableConcept
• use: string
  • usual
  • official
  • temp
  • secondary
  • old (if known)
• value: string
  The value that is unique.

{
    "type":"object",
    "properties":{
        "use":{
            "type":"string",
            "description":"<ul> <li><code>usual</code></li> <li><code>official</code></li> <li><code>temp</code></li> <li><code>secondary</code></li> <li><code>old</code> (if known)</li> </ul>"
        },
        "type":{
            "$ref":"#/definitions/CodeableConcept"
        },
        "system":{
            "type":"string",
            "description":"The namespace for the identifier value (URI)."
        },
        "value":{
            "type":"string",
            "description":"The value that is unique."
        },
        "period":{
            "$ref":"#/definitions/Period"
        }
    }
}

Nested Schema : TaskInput

The input parameter for a Task. This endpoint supports the CDEX Task Data Request query pattern. The required query input uses the Da Vinci Health Record Exchange (HRex) data-query code. The resource being queried is identified by the FHIR search string in valueString, for example, DocumentReference?patient=...

Match All

The input parameter for a Task. This endpoint supports the CDEX Task Data Request query pattern. The required query input uses the Da Vinci Health Record Exchange (HRex) data-query code. The resource being queried is identified by the FHIR search string in valueString, for example, DocumentReference?patient=...

The input parameter for a Task. This endpoint supports the CDEX Task Data Request query pattern. The required query input uses the Da Vinci Health Record Exchange (HRex) data-query code. The resource being queried is identified by the FHIR search string in valueString, for example, DocumentReference?patient=...

Show Source

• allOf BackBoneElement
• object TaskInput-allOf[1]

{
    "description":"The input parameter for a Task. This endpoint supports the CDEX Task Data Request query pattern. The required query input uses the <a href=\"http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp\">Da Vinci Health Record Exchange</a> (HRex) <code>data-query</code> code. The resource being queried is identified by the FHIR search string in <code>valueString</code>, for example, <code>DocumentReference?patient=...</code>",
    "allOf":[
        {
            "$ref":"#/definitions/BackBoneElement"
        },
        {
            "type":"object",
            "required":[
                "type",
                "valueString"
            ],
            "properties":{
                "type":{
                    "$ref":"#/definitions/CodeableConcept"
                },
                "valueString":{
                    "type":"string",
                    "description":"The DocumentReference search request to run asynchronously, for example, <code>DocumentReference?patient=2971696001&date=ge2024-07-15&date=le2025-08-08</code>."
                }
            }
        }
    ]
}

Nested Schema : BackBoneElement

Match All

Show Source

• object Element
• object BackBoneElement-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/Element"
        },
        {
            "type":"object",
            "properties":{
                "modifierExtension":{
                    "$ref":"#/definitions/Extension"
                }
            }
        }
    ]
}

Nested Schema : BackBoneElement-allOf[1]

Type: object

Show Source

• modifierExtension: object Extension

{
    "type":"object",
    "properties":{
        "modifierExtension":{
            "$ref":"#/definitions/Extension"
        }
    }
}

Nested Schema : TaskInput-allOf[1]

Type: object

Show Source

• type(required): CodeableConcept
• valueString(required): string
  The DocumentReference search request to run asynchronously, for example, DocumentReference?patient=2971696001&date=ge2024-07-15&date=le2025-08-08.

{
    "type":"object",
    "required":[
        "type",
        "valueString"
    ],
    "properties":{
        "type":{
            "$ref":"#/definitions/CodeableConcept"
        },
        "valueString":{
            "type":"string",
            "description":"The DocumentReference search request to run asynchronously, for example, <code>DocumentReference?patient=2971696001&date=ge2024-07-15&date=le2025-08-08</code>."
        }
    }
}

Nested Schema : profile

Type: array

The profiles this resource claims to conform to.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The profiles this resource claims to conform to.",
    "items":{
        "type":"string"
    }
}

Nested Schema : TaskOutput

The output parameter for a completed Task. Completed search output uses the HRex data-value code.

Match All

The output parameter for a completed Task. Completed search output uses the HRex data-value code.

The output parameter for a completed Task. Completed search output uses the HRex data-value code.

Show Source

• allOf BackBoneElement
• object TaskOutput-allOf[1]

{
    "description":"The output parameter for a completed Task. Completed search output uses the <a href=\"http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp\">HRex</a> <code>data-value</code> code.",
    "allOf":[
        {
            "$ref":"#/definitions/BackBoneElement"
        },
        {
            "type":"object",
            "required":[
                "type",
                "valueReference"
            ],
            "properties":{
                "type":{
                    "$ref":"#/definitions/CodeableConcept"
                },
                "valueReference":{
                    "$ref":"#/definitions/Reference"
                }
            }
        }
    ]
}

Nested Schema : TaskOutput-allOf[1]

Type: object

Show Source

• type(required): CodeableConcept
• valueReference(required): Reference

{
    "type":"object",
    "required":[
        "type",
        "valueReference"
    ],
    "properties":{
        "type":{
            "$ref":"#/definitions/CodeableConcept"
        },
        "valueReference":{
            "$ref":"#/definitions/Reference"
        }
    }
}

Nested Schema : TaskReasonCode-allOf[1]

Type: object

Show Source

• text(required): string
  The human-readable reason the information is being requested.

{
    "type":"object",
    "required":[
        "text"
    ],
    "properties":{
        "text":{
            "type":"string",
            "description":"The human-readable reason the information is being requested."
        }
    }
}

Nested Schema : TaskStatusReason-allOf[1]

Type: object

Show Source

• text(required): string
  The human-readable reason the Task failed or was rejected.

{
    "type":"object",
    "required":[
        "text"
    ],
    "properties":{
        "text":{
            "type":"string",
            "description":"The human-readable reason the Task failed or was rejected."
        }
    }
}

401 Response

Authorization information is missing or invalid.

403 Response

The caller cannot access this Task.

404 Response

The requested Task was not found. This can occur when the Task ID is invalid or the Task is requested after the retention period expires.

500 Response

Internal Server error.

Back to Top