FHIR DSTU 2 APIs for Oracle Health Millennium Platform

Get a list of contracts

get

/Contract

Retrieves contracts that meet supplied query parameters.

Note:

Either the _id or one of actor, actor.identifier, patient.identifier, or subject parameters must be provided.

Request

Query Parameters

_id: string

The logical resource ID. This parameter is required if actor, actor.identifier, patient.identifier, or subject are not used.
_include: string
Other resource entries to be returned as part of the bundle.
Note:
- May be provided once for each resource to be included. For example, _include=Contract:actor&_include=Contract:patient.
- Additional OAuth2 scopes are required when the _include parameter is provided. To include with Contract:actor or Contract:patient values, the OAuth2 token must include scopes for one or both RelatedPerson.read and Patient.read, respectively, depending on the combination of resources to be included.
Example: _include=Contract:actor or _include=Contract:patient
actor: string
The actor (related person) of the contract. This parameter is required if _id is not used.
Note:
- May be provided exactly once and may have only a single value.
Example: actor=RelatedPerson/1234 or actor:RelatedPerson=1234
actor.identifier: string
The identifier for the actor of the contract. This parameter is required if _id is not used.
Note:
- May be provided exactly once and may have only a single value.
Example: actor.identifier=system|1234
patient.identifier: string
The identifier for the patient subject of the contract. This parameter is required if _id is not used.
Note:
- May be provided exactly once and may have only a single value.
Example: patient.identifier=system|5678
subject: string
The subject (patient) of the contract. This parameter is required if _id is not used.
Note:
- May be provided exactly once and may have only a single value.
Example: subject=Patient/1234 or subject:Patient=1234

Header Parameters

Authorization(required): string

Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.
accept(required): string

The media type to be requested. See what the resource's operation produces for what is supported.

Response

Supported Media Types

application/json+fhir

Default Response

This operation supports the following authorization types:

Provider
Patient
System

Example Request:

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Contract?subject:Patient=12724069

Example Response:

{
  "resourceType": "Bundle",
  "id": "fc4d9945-4b1d-40fd-ad34-47df3c5ccdc3",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Contract?subject=Patient%2F12724069"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Contract/490059635",
      "resource": {
        "resourceType": "Contract",
        "id": "490068369",
        "meta": {
          "versionId": "51"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Contract</b></p><p><b>Actor Name</b>: SMART, NANCY</p><p><b>Subject Name</b>: SMART, TIMMY</p><p><b>Applies Begin</b>: Aug 10, 2020  4:37 P.M. UTC</p><p><b>Type</b>: Consent report (record artifact)</p><p><b>Subtype</b>: Consent status (finding)</p></div>"
        },
        "applies": {
          "start": "2020-08-10T16:37:51.000Z"
        },
        "subject": [
          {
            "reference": "Patient/12724069",
            "display": "SMART, TIMMY"
          }
        ],
        "type": {
          "coding": [
            {
              "system": "https://snomed.ct/sct",
              "code": "371537001",
              "display": "Consent report (record artifact)"
            }
          ],
          "text": "Consent report (record artifact)"
        },
        "subtype": [
          {
            "coding": [
              {
                "system": "https://snomed.ct/sct",
                "code": "309370004",
                "display": "Consent status (finding)"
              }
            ],
            "text": "Consent status (finding)"
          }
        ],
        "action": [
          {
            "coding": [
              {
                "system": "https://snomed.ct/sct",
                "code": "441898007",
                "display": "Consented (qualifier value)"
              }
            ],
            "text": "Consented (qualifier value)"
          }
        ],
        "actionReason": [
          {
            "coding": [
              {
                "system": "https://snomed.ct/sct",
                "code": "425691002",
                "display": "Consent given for electronic record sharing (finding)"
              }
            ],
            "text": "Consent given for electronic record sharing (finding)"
          }
        ],
        "actor": [
          {
            "entity": {
              "reference": "RelatedPerson/490068369",
              "display": "SMART, NANCY"
            },
            "role": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "442681007",
                    "display": "Recipient consented (qualifier value)"
                  }
                ],
                "text": "Authorized Representative"
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Headers

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.

x-include Response

This operation supports the following authorization types:

Provider
Patient
System

Example Request:

GET  https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Contract?subject=Patient%2F12724069&_include=Contract%3Aactor

Example Response:

{
  "resourceType": "Bundle",
  "id": "4b5ccc13-a96a-4037-b58a-2393d4dbefbd",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Contract?subject=Patient%2F12724069&_include=Contract%3Aactor"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Contract/490059635",
      "resource": {
        "resourceType": "Contract",
        "id": "490068369",
        "meta": {
          "versionId": "51"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Contract</b></p><p><b>Actor Name</b>: SMART, NANCY</p><p><b>Subject Name</b>: SMART, TIMMY</p><p><b>Applies Begin</b>: Aug 10, 2020  4:37 P.M. UTC</p><p><b>Type</b>: Consent report (record artifact)</p><p><b>Subtype</b>: Consent status (finding)</p></div>"
        },
        "applies": {
          "start": "2020-08-10T16:37:51.000Z"
        },
        "subject": [
          {
            "reference": "Patient/12724069",
            "display": "SMART, TIMMY"
          }
        ],
        "type": {
          "coding": [
            {
              "system": "https://snomed.ct/sct",
              "code": "371537001",
              "display": "Consent report (record artifact)"
            }
          ],
          "text": "Consent report (record artifact)"
        },
        "subtype": [
          {
            "coding": [
              {
                "system": "https://snomed.ct/sct",
                "code": "309370004",
                "display": "Consent status (finding)"
              }
            ],
            "text": "Consent status (finding)"
          }
        ],
        "action": [
          {
            "coding": [
              {
                "system": "https://snomed.ct/sct",
                "code": "441898007",
                "display": "Consented (qualifier value)"
              }
            ],
            "text": "Consented (qualifier value)"
          }
        ],
        "actionReason": [
          {
            "coding": [
              {
                "system": "https://snomed.ct/sct",
                "code": "425691002",
                "display": "Consent given for electronic record sharing (finding)"
              }
            ],
            "text": "Consent given for electronic record sharing (finding)"
          }
        ],
        "actor": [
          {
            "entity": {
              "reference": "RelatedPerson/490068369",
              "display": "SMART, NANCY"
            },
            "role": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "442681007",
                    "display": "Recipient consented (qualifier value)"
                  }
                ],
                "text": "Authorized Representative"
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/490059635",
      "resource": {
        "resourceType": "RelatedPerson",
        "id": "490059635",
        "meta": {
          "versionId": "2"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>RelatedPerson</b></p><p><b>Name</b>: Smart, Nancy</p><p><b>DOB</b>: Jan  6, 1972</p><p><b>Sex</b>: Female</p></div>"
        },
        "patient": {
          "reference": "Patient/12724069",
          "display": "SMART, TIMMY"
        },
        "name": {
          "use": "official",
          "text": "Smart, Nancy",
          "family": [
            "Smart"
          ],
          "given": [
            "Nancy"
          ],
          "period": {
            "start": "2020-06-30T20:41:33.000Z"
          }
        },
        "telecom": [
          {
            "system": "email",
            "value": "timmysmart@yopmail.com",
            "use": "home",
            "period": {
              "start": "2020-06-30T20:41:33.000Z"
            }
          }
        ],
        "gender": "female",
        "birthDate": "1972-01-06",
        "period": {
          "start": "2020-06-30T20:41:33.000Z"
        }
      },
      "search": {
        "mode": "include"
      }
    }
  ]
}

Headers

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.