Jump to

• Request
• Response

Kick off a bulk export request for the provided list of patients

post

/Patient/$export

The operation is defined at:

GET https://fhir-ehr.cerner.com/r4/OperationDefinition/patient-export?_format=json

Note:

• With the current implementation, the patient parameter must be provided at least once.
• Bulk data export requests do not currently recognize the Accept-Language header; en-US is used instead.
• Only one bulk export request for a client application and tenant combination may be in-progress at a single time.
• The authorization token must contain system read scopes for all resources requested in the _type parameter.
• The experimental _elements parameter is not supported.

Provenance Behavior

• Provenances for the Location, Organization, and Practitioner resources cannot be exported.
• When the _type parameter is not provided and the authorization token includes the Provenance read scope, all relevant Provenance resources associated with each of the non-Provenance resources are exported by default. You may use the includeAssociatedData parameter to export only the latest provenance.
• When the _type parameter is provided with specific resources and includes Provenance, all relevant Provenance resources associated with each of the non-Provenance resources are exported by default.
• When both the includeAssociatedData parameter and the _type parameter are provided, the _type parameter must include Provenance.

Optional Header

When the Prefer: handling=lenient header is provided, any unknown or unsupported parameters are ignored as specified in the Bulk Data Export parameters.

Request

Header Parameters

• Accept(required): string
  The media type to be requested. See what the resource's operation produces for what is supported.
• Authorization(required): string
  Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
• Content-Type(required): string
  Specifies the content type of the request entity body. Accepted values are application/fhir+json, application/json+fhir, and application/json.
• Prefer(required): string
  Specifies whether the response is immediate or asynchronous. respond-async is supported. A client must provide this header.

Body ()

The body of the patient export operation.

Root Schema : PatientExport

Type: object

A summary representation of the patient export (POST) operation.

Show Source

• parameter(required): array parameter

  Parameters supported by the operation.

  • The patient parameter is required and must be provided at least once.
  • The _type, _typeFilter, includeAssociatedData, _since, and _outputFormat parameters are optional and may be provided in the request body.

  Details of the supported parameters:

  • patient:
    • A maximum of 20,000 values may be provided for patient.
    • When the parameter name is patient, the parameter value must be in the form of valueReference.
  • _type:
    • A string of comma-delimited FHIR resource types.
    • When the parameter name is _type, the parameter value must be in the form of valueString.
    • The following values are valid:
    • AllergyIntolerance
    • CarePlan
    • CareTeam
    • Condition
    • Device
    • DiagnosticReport
    • DocumentReference
    • Encounter
    • Goal
    • Immunization
    • Location
    • MedicationRequest
    • Patient
    • Procedure
    • Observation
    • Organization
    • Practitioner
    • Provenance
    • When the _type parameter contains a reference resource (Location, Organization, or Practitioner) or associated resource (Provenance), at least one of the following resources must also be provided:
      • AllergyIntolerance
      • CarePlan
      • CareTeam
      • Condition
      • Device
      • DiagnosticReport
      • DocumentReference
      • Encounter
      • Goal
      • Immunization
      • MedicationRequest
      • Observation
      • Patient
      • Procedure
    • When the _type parameter is not provided, the resources to be exported are determined by the scopes provided in the authorization token.
    • Example: Condition, Provenance
  • _typeFilter:
    • A string of comma-delimited FHIR REST queries provided in combination with _type.
    • When the parameter name is _typeFilter, the parameter value must be in the form of valueString.
    • When the _typeFilter parameter is provided, the _type parameter must be provided and must only have queries for the resources provided in _type.
    • _typeFilter does not support queries for the following resources:
      • Location
      • Organization
      • Patient
      • Practitioner
      • Provenance
    • _typeFilter supports queries with the search parameters supported for the R4 resources with the exception of the following search parameters:
      • _count
      • _contained
      • _containedType
      • _elements
      • _id
      • _include
      • _lastUpdated
      • _revinclude
      • _sort
      • _summary
      • _total
      • encounter
      • identifier
      • patient
      • subject
      • date
    • Supplying _typeFilter with the same resource multiple times is not supported.
    • Example: Condition?clinical-status=active,Encounter?status=planned
  • includeAssociatedData:
    • When the parameter name is includeAssociatedData, the parameter value must be in the form of valueCode.
    • When provided, the patient export returns or omits a predefined set of FHIR resources associated with the request.
    • A string of comma-delimited values. Valid values are LatestProvenanceResources and RelevantProvenanceResources.
  • _since:
    • Resources updated after this time are included in the response.
    • When the parameter name is _since, the parameter value must be in the form of valueInstant.
    • Example: 2021-03-18T19:19:42.000Z
  • _outputFormat:
    • The format for the requested bulk data files to be generated.
    • When the parameter name is _outputFormat, the parameter value must be in the form of valueString.
    • Valid values are application/fhir+ndjson, application/ndjson, and ndjson.
    • Defaults to application/fhir+ndjson when not provided.

  {
    "parameter": [
      {
        "name": "patient",
        "valueReference": { "reference": "Patient/12783127" }
      },
      {
        "name": "patient",
        "valueReference": { "reference": "Patient/12783128" }
      },
      {
        "name": "patient",
        "valueReference": { "reference": "Patient/12783129" }
      },
      {
        "name": "_type",
        "valueString": "Condition,Provenance"
      },
      {
        "name": "_typeFilter",
        "valueString": "Condition?category=problem-list-item"
      },
      {
        "name": "includeAssociatedData",
        "valueCode": "RelevantProvenanceResources"
      },
      {
        "name": "_since",
        "valueInstant": "2021-03-18T19:19:42.000Z"
      },
      {
        "name": "_outputFormat",
        "valueString": "application/fhir+ndjson"
      }
    ]
  }
  

• resourceType(required): string
  Allowed Values: [ "Parameters" ]

  The type of the FHIR resource.

  {
    "resourceType": "Parameters",
  }
  

{
    "description":"A summary representation of the patient export (POST) operation.",
    "type":"object",
    "required":[
        "resourceType",
        "parameter"
    ],
    "properties":{
        "resourceType":{
            "description":"<p>The type of the FHIR resource.</p>\n<pre>\n<code>{\n  \"resourceType\": \"Parameters\",\n}</code>\n</pre>\n",
            "type":"string",
            "enum":[
                "Parameters"
            ]
        },
        "parameter":{
            "description":"<p>Parameters supported by the operation.</p>\n<ul>\n  <li>The <code>patient</code> parameter is required and must be provided at least once.</li>\n  <li>The <code>_type</code>, <code>_typeFilter</code>, <code>includeAssociatedData</code>, <code>_since</code>, and <code>_outputFormat</code> parameters are optional and may be provided in the request body.</li>\n</ul>\n<p>Details of the supported parameters:\n  <ul>\n    <li><code>patient</code>:\n      <ul>\n        <li>A maximum of 20,000 values may be provided for <code>patient</code>.</li>\n        <li>When the parameter name is <code>patient</code>, the parameter value must be in the form of <code>valueReference</code>.</li>\n      </ul>\n    </li>\n    <li><code>_type</code>:\n      <ul>\n        <li>A string of comma-delimited FHIR resource types.</li>\n        <li> When the parameter name is <code>_type</code>, the parameter value must be in the form of <code>valueString</code>.</li>\n        <li>The following values are valid:</li>\n          <ul>\n            <li><code>AllergyIntolerance</code></li>\n            <li><code>CarePlan</code></li>\n            <li><code>CareTeam</code></li>\n            <li><code>Condition</code></li>\n            <li><code>Device</code></li>\n            <li><code>DiagnosticReport</code></li>\n            <li><code>DocumentReference</code></li>\n            <li><code>Encounter</code></li>\n            <li><code>Goal</code></li>\n            <li><code>Immunization</code></li> \n            <li><code>Location</code></li>\n            <li><code>MedicationRequest</code></li>\n            <li><code>Patient</code></li>\n            <li><code>Procedure</code></li>\n            <li><code>Observation</code></li>\n            <li><code>Organization</code></li>\n            <li><code>Practitioner</code></li>\n            <li><code>Provenance</code></li>\n          </ul>\n        <li>When the <code>_type</code> parameter contains a reference resource (<code>Location</code>, <code>Organization</code>, or <code>Practitioner</code>) or associated resource (<code>Provenance</code>), at least one of the following resources must also be provided: \n          <ul>\n            <li><code>AllergyIntolerance</code></li>\n            <li><code>CarePlan</code></li>\n            <li><code>CareTeam</code></li>\n            <li><code>Condition</code></li>\n            <li><code>Device</code></li>\n            <li><code>DiagnosticReport</code></li>\n            <li><code>DocumentReference</code></li>\n            <li><code>Encounter</code></li>\n            <li><code>Goal</code></li>\n            <li><code>Immunization</code></li>\n            <li><code>MedicationRequest</code></li>\n            <li><code>Observation</code></li>\n            <li><code>Patient</code></li>\n            <li><code>Procedure</code></li>\n          </ul>\n        <li>When the <code>_type</code> parameter is not provided, the resources to be exported are determined by the scopes provided in the authorization token.</li>\n        <li>Example: <code>Condition, Provenance</code></li>\n      </ul>\n    </li>\n    <li><code>_typeFilter</code>:\n      <ul>\n        <li>A string of comma-delimited FHIR REST queries provided in combination with <code>_type</code>.</li>\n        <li>When the parameter name is <code>_typeFilter</code>, the parameter value must be in the form of <code>valueString</code>.</li>\n        <li>When the <code>_typeFilter</code> parameter is provided, the <code>_type</code> parameter must be provided and must only have queries for the resources provided in <code>_type</code>.</li>\n        <li><code>_typeFilter</code> does not support queries for the following resources: \n          <ul>\n            <li><code>Location</code></li>\n            <li><code>Organization</code></li>\n            <li><code>Patient</code></li>\n            <li><code>Practitioner</code></li>\n            <li><code>Provenance</code></li>\n          </ul>\n        <li><code>_typeFilter</code> supports queries with the search parameters supported for the <a href=\"https://docs.oracle.com/en/industries/health/millennium-platform-apis/mfrap/resource_info.html\">R4</a> resources with the exception of the following search parameters:\n          <ul>\n            <li><code>_count</code></li>\n            <li><code>_contained</code></li>\n            <li><code>_containedType</code></li>\n            <li><code>_elements</code></li>\n            <li><code>_id</code></li>\n            <li><code>_include</code></li>\n            <li><code>_lastUpdated</code></li>\n            <li><code>_revinclude</code></li>\n            <li><code>_sort</code></li>\n            <li><code>_summary</code></li>\n            <li><code>_total</code></li>\n            <li><code>encounter</code></li>\n            <li><code>identifier</code></li>\n            <li><code>patient</code></li>\n            <li><code>subject</code></li>\n            <li><code>date</code></li>\n          </ul>\n        <li>Supplying <code>_typeFilter</code> with the same resource multiple times is not supported.</li>\n        <li>Example: <code>Condition?clinical-status=active,Encounter?status=planned</code></li>\n      </ul>\n    </li>\n    <li><code>includeAssociatedData</code>:\n      <ul>\n        <li>When the parameter name is <code>includeAssociatedData</code>, the parameter value must be in the form of <code>valueCode</code>.</li>\n        <li>When provided, the patient export returns or omits a predefined set of FHIR resources associated with the request.</li>\n        <li>A string of comma-delimited values. Valid values are <code>LatestProvenanceResources</code> and <code>RelevantProvenanceResources</code>.</li>\n      </ul>\n    </li>\n    <li><code>_since</code>:\n      <ul>\n        <li>Resources updated after this time are included in the response.</li>\n        <li>When the parameter name is <code>_since</code>, the parameter value must be in the form of <code>valueInstant</code>.</li>\n        <li>Example: <code>2021-03-18T19:19:42.000Z</code></li>\n      </ul>\n    </li>\n    <li><code>_outputFormat</code>:\n      <ul>\n        <li>The format for the requested bulk data files to be generated.</li>\n        <li>When the parameter name is <code>_outputFormat</code>, the parameter value must be in the form of <code>valueString</code>.</li>\n        <li>Valid values are <code>application/fhir+ndjson</code>, <code>application/ndjson</code>, and <code>ndjson</code>.</li>\n        <li>Defaults to <code>application/fhir+ndjson</code> when not provided.</li>\n      </ul>\n    </li>\n  </ul>\n</p>\n\n<pre>\n<code>{\n  \"parameter\": [\n    {\n      \"name\": \"patient\",\n      \"valueReference\": { \"reference\": \"Patient/12783127\" }\n    },\n    {\n      \"name\": \"patient\",\n      \"valueReference\": { \"reference\": \"Patient/12783128\" }\n    },\n    {\n      \"name\": \"patient\",\n      \"valueReference\": { \"reference\": \"Patient/12783129\" }\n    },\n    {\n      \"name\": \"_type\",\n      \"valueString\": \"Condition,Provenance\"\n    },\n    {\n      \"name\": \"_typeFilter\",\n      \"valueString\": \"Condition?category=problem-list-item\"\n    },\n    {\n      \"name\": \"includeAssociatedData\",\n      \"valueCode\": \"RelevantProvenanceResources\"\n    },\n    {\n      \"name\": \"_since\",\n      \"valueInstant\": \"2021-03-18T19:19:42.000Z\"\n    },\n    {\n      \"name\": \"_outputFormat\",\n      \"valueString\": \"application/fhir+ndjson\"\n    }\n  ]\n}</code>\n</pre>\n",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"The name of the parameter\n",
                        "type":"string"
                    },
                    "value[x]":{
                        "description":"The value of the parameter\n",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : parameter

Type: array

Parameters supported by the operation.

• The patient parameter is required and must be provided at least once.
• The _type, _typeFilter, includeAssociatedData, _since, and _outputFormat parameters are optional and may be provided in the request body.

Details of the supported parameters:

• patient:
  • A maximum of 20,000 values may be provided for patient.
  • When the parameter name is patient, the parameter value must be in the form of valueReference.
• _type:
  • A string of comma-delimited FHIR resource types.
  • When the parameter name is _type, the parameter value must be in the form of valueString.
  • The following values are valid:
  • AllergyIntolerance
  • CarePlan
  • CareTeam
  • Condition
  • Device
  • DiagnosticReport
  • DocumentReference
  • Encounter
  • Goal
  • Immunization
  • Location
  • MedicationRequest
  • Patient
  • Procedure
  • Observation
  • Organization
  • Practitioner
  • Provenance
  • When the _type parameter contains a reference resource (Location, Organization, or Practitioner) or associated resource (Provenance), at least one of the following resources must also be provided:
    • AllergyIntolerance
    • CarePlan
    • CareTeam
    • Condition
    • Device
    • DiagnosticReport
    • DocumentReference
    • Encounter
    • Goal
    • Immunization
    • MedicationRequest
    • Observation
    • Patient
    • Procedure
  • When the _type parameter is not provided, the resources to be exported are determined by the scopes provided in the authorization token.
  • Example: Condition, Provenance
• _typeFilter:
  • A string of comma-delimited FHIR REST queries provided in combination with _type.
  • When the parameter name is _typeFilter, the parameter value must be in the form of valueString.
  • When the _typeFilter parameter is provided, the _type parameter must be provided and must only have queries for the resources provided in _type.
  • _typeFilter does not support queries for the following resources:
    • Location
    • Organization
    • Patient
    • Practitioner
    • Provenance
  • _typeFilter supports queries with the search parameters supported for the R4 resources with the exception of the following search parameters:
    • _count
    • _contained
    • _containedType
    • _elements
    • _id
    • _include
    • _lastUpdated
    • _revinclude
    • _sort
    • _summary
    • _total
    • encounter
    • identifier
    • patient
    • subject
    • date
  • Supplying _typeFilter with the same resource multiple times is not supported.
  • Example: Condition?clinical-status=active,Encounter?status=planned
• includeAssociatedData:
  • When the parameter name is includeAssociatedData, the parameter value must be in the form of valueCode.
  • When provided, the patient export returns or omits a predefined set of FHIR resources associated with the request.
  • A string of comma-delimited values. Valid values are LatestProvenanceResources and RelevantProvenanceResources.
• _since:
  • Resources updated after this time are included in the response.
  • When the parameter name is _since, the parameter value must be in the form of valueInstant.
  • Example: 2021-03-18T19:19:42.000Z
• _outputFormat:
  • The format for the requested bulk data files to be generated.
  • When the parameter name is _outputFormat, the parameter value must be in the form of valueString.
  • Valid values are application/fhir+ndjson, application/ndjson, and ndjson.
  • Defaults to application/fhir+ndjson when not provided.

{
  "parameter": [
    {
      "name": "patient",
      "valueReference": { "reference": "Patient/12783127" }
    },
    {
      "name": "patient",
      "valueReference": { "reference": "Patient/12783128" }
    },
    {
      "name": "patient",
      "valueReference": { "reference": "Patient/12783129" }
    },
    {
      "name": "_type",
      "valueString": "Condition,Provenance"
    },
    {
      "name": "_typeFilter",
      "valueString": "Condition?category=problem-list-item"
    },
    {
      "name": "includeAssociatedData",
      "valueCode": "RelevantProvenanceResources"
    },
    {
      "name": "_since",
      "valueInstant": "2021-03-18T19:19:42.000Z"
    },
    {
      "name": "_outputFormat",
      "valueString": "application/fhir+ndjson"
    }
  ]
}

Show Source

• Array of: object items

{
    "description":"<p>Parameters supported by the operation.</p>\n<ul>\n  <li>The <code>patient</code> parameter is required and must be provided at least once.</li>\n  <li>The <code>_type</code>, <code>_typeFilter</code>, <code>includeAssociatedData</code>, <code>_since</code>, and <code>_outputFormat</code> parameters are optional and may be provided in the request body.</li>\n</ul>\n<p>Details of the supported parameters:\n  <ul>\n    <li><code>patient</code>:\n      <ul>\n        <li>A maximum of 20,000 values may be provided for <code>patient</code>.</li>\n        <li>When the parameter name is <code>patient</code>, the parameter value must be in the form of <code>valueReference</code>.</li>\n      </ul>\n    </li>\n    <li><code>_type</code>:\n      <ul>\n        <li>A string of comma-delimited FHIR resource types.</li>\n        <li> When the parameter name is <code>_type</code>, the parameter value must be in the form of <code>valueString</code>.</li>\n        <li>The following values are valid:</li>\n          <ul>\n            <li><code>AllergyIntolerance</code></li>\n            <li><code>CarePlan</code></li>\n            <li><code>CareTeam</code></li>\n            <li><code>Condition</code></li>\n            <li><code>Device</code></li>\n            <li><code>DiagnosticReport</code></li>\n            <li><code>DocumentReference</code></li>\n            <li><code>Encounter</code></li>\n            <li><code>Goal</code></li>\n            <li><code>Immunization</code></li> \n            <li><code>Location</code></li>\n            <li><code>MedicationRequest</code></li>\n            <li><code>Patient</code></li>\n            <li><code>Procedure</code></li>\n            <li><code>Observation</code></li>\n            <li><code>Organization</code></li>\n            <li><code>Practitioner</code></li>\n            <li><code>Provenance</code></li>\n          </ul>\n        <li>When the <code>_type</code> parameter contains a reference resource (<code>Location</code>, <code>Organization</code>, or <code>Practitioner</code>) or associated resource (<code>Provenance</code>), at least one of the following resources must also be provided: \n          <ul>\n            <li><code>AllergyIntolerance</code></li>\n            <li><code>CarePlan</code></li>\n            <li><code>CareTeam</code></li>\n            <li><code>Condition</code></li>\n            <li><code>Device</code></li>\n            <li><code>DiagnosticReport</code></li>\n            <li><code>DocumentReference</code></li>\n            <li><code>Encounter</code></li>\n            <li><code>Goal</code></li>\n            <li><code>Immunization</code></li>\n            <li><code>MedicationRequest</code></li>\n            <li><code>Observation</code></li>\n            <li><code>Patient</code></li>\n            <li><code>Procedure</code></li>\n          </ul>\n        <li>When the <code>_type</code> parameter is not provided, the resources to be exported are determined by the scopes provided in the authorization token.</li>\n        <li>Example: <code>Condition, Provenance</code></li>\n      </ul>\n    </li>\n    <li><code>_typeFilter</code>:\n      <ul>\n        <li>A string of comma-delimited FHIR REST queries provided in combination with <code>_type</code>.</li>\n        <li>When the parameter name is <code>_typeFilter</code>, the parameter value must be in the form of <code>valueString</code>.</li>\n        <li>When the <code>_typeFilter</code> parameter is provided, the <code>_type</code> parameter must be provided and must only have queries for the resources provided in <code>_type</code>.</li>\n        <li><code>_typeFilter</code> does not support queries for the following resources: \n          <ul>\n            <li><code>Location</code></li>\n            <li><code>Organization</code></li>\n            <li><code>Patient</code></li>\n            <li><code>Practitioner</code></li>\n            <li><code>Provenance</code></li>\n          </ul>\n        <li><code>_typeFilter</code> supports queries with the search parameters supported for the <a href=\"https://docs.oracle.com/en/industries/health/millennium-platform-apis/mfrap/resource_info.html\">R4</a> resources with the exception of the following search parameters:\n          <ul>\n            <li><code>_count</code></li>\n            <li><code>_contained</code></li>\n            <li><code>_containedType</code></li>\n            <li><code>_elements</code></li>\n            <li><code>_id</code></li>\n            <li><code>_include</code></li>\n            <li><code>_lastUpdated</code></li>\n            <li><code>_revinclude</code></li>\n            <li><code>_sort</code></li>\n            <li><code>_summary</code></li>\n            <li><code>_total</code></li>\n            <li><code>encounter</code></li>\n            <li><code>identifier</code></li>\n            <li><code>patient</code></li>\n            <li><code>subject</code></li>\n            <li><code>date</code></li>\n          </ul>\n        <li>Supplying <code>_typeFilter</code> with the same resource multiple times is not supported.</li>\n        <li>Example: <code>Condition?clinical-status=active,Encounter?status=planned</code></li>\n      </ul>\n    </li>\n    <li><code>includeAssociatedData</code>:\n      <ul>\n        <li>When the parameter name is <code>includeAssociatedData</code>, the parameter value must be in the form of <code>valueCode</code>.</li>\n        <li>When provided, the patient export returns or omits a predefined set of FHIR resources associated with the request.</li>\n        <li>A string of comma-delimited values. Valid values are <code>LatestProvenanceResources</code> and <code>RelevantProvenanceResources</code>.</li>\n      </ul>\n    </li>\n    <li><code>_since</code>:\n      <ul>\n        <li>Resources updated after this time are included in the response.</li>\n        <li>When the parameter name is <code>_since</code>, the parameter value must be in the form of <code>valueInstant</code>.</li>\n        <li>Example: <code>2021-03-18T19:19:42.000Z</code></li>\n      </ul>\n    </li>\n    <li><code>_outputFormat</code>:\n      <ul>\n        <li>The format for the requested bulk data files to be generated.</li>\n        <li>When the parameter name is <code>_outputFormat</code>, the parameter value must be in the form of <code>valueString</code>.</li>\n        <li>Valid values are <code>application/fhir+ndjson</code>, <code>application/ndjson</code>, and <code>ndjson</code>.</li>\n        <li>Defaults to <code>application/fhir+ndjson</code> when not provided.</li>\n      </ul>\n    </li>\n  </ul>\n</p>\n\n<pre>\n<code>{\n  \"parameter\": [\n    {\n      \"name\": \"patient\",\n      \"valueReference\": { \"reference\": \"Patient/12783127\" }\n    },\n    {\n      \"name\": \"patient\",\n      \"valueReference\": { \"reference\": \"Patient/12783128\" }\n    },\n    {\n      \"name\": \"patient\",\n      \"valueReference\": { \"reference\": \"Patient/12783129\" }\n    },\n    {\n      \"name\": \"_type\",\n      \"valueString\": \"Condition,Provenance\"\n    },\n    {\n      \"name\": \"_typeFilter\",\n      \"valueString\": \"Condition?category=problem-list-item\"\n    },\n    {\n      \"name\": \"includeAssociatedData\",\n      \"valueCode\": \"RelevantProvenanceResources\"\n    },\n    {\n      \"name\": \"_since\",\n      \"valueInstant\": \"2021-03-18T19:19:42.000Z\"\n    },\n    {\n      \"name\": \"_outputFormat\",\n      \"valueString\": \"application/fhir+ndjson\"\n    }\n  ]\n}</code>\n</pre>\n",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"The name of the parameter\n",
                "type":"string"
            },
            "value[x]":{
                "description":"The value of the parameter\n",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  The name of the parameter
• value[x]: string
  The value of the parameter

{
    "type":"object",
    "properties":{
        "name":{
            "description":"The name of the parameter\n",
            "type":"string"
        },
        "value[x]":{
            "description":"The value of the parameter\n",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/fhir+json

Default Response

This operation supports the System authorization type.
Example Request:

POST https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/$export

Example Request Body:

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "patient",
      "valueReference": { "reference": "Patient/12783127" }
    },
    {
      "name": "patient",
      "valueReference": { "reference": "Patient/12783128" }
    },
    {
      "name": "patient",
      "valueReference": { "reference": "Patient/12783129" }
    },
    {
      "name": "_type",
      "valueString": "Condition,Provenance"
    },
    {
      "name": "_typeFilter",
      "valueString": "Condition?category=problem-list-item"
    },
    {
      "name": "includeAssociatedData",
      "valueCode": "RelevantProvenanceResources"
    },
    {
      "name": "_since",
      "valueInstant": "2021-03-18T19:19:42.000Z"
    },
    {
      "name": "_outputFormat",
      "valueString": "application/fhir+ndjson"
    }
  ]
}

Example Response:

Status: 202 Accepted
Content-Location: https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/jobs/<Job_ID>

Headers

• Content-Location: string
  Indicates the url to access the status of the export request.
• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-request-id, if present.

Back to Top