Contract

Overview
Terminology Bindings
Search
Retrieve by id

Overview

The Contract resource is currently limited to representing people who are authorized to view a patient’s data. For this reason, contract type, subtype, action and reason are always set to values related to consent for EHR sharing. The subject of the contract is the patient. The actors on the contract are the related people who are authorized to view the subject patient’s data. An example is a contract authorizing a mother (actor) to view her child’s data (subject).

The following fields are returned if valued:

Terminology Bindings

Contract.type

Description

List of overall contract codes.

Details: SNOMED CT
System: http://snomed.info/sct

Supported Values

371537001 - Consent report (record artifact)

Contract.subType

Description

Detailed codes within the above.

Details: SNOMED CT
System: http://snomed.info/sct

Supported Values

309370004 - Consent status (finding)

Contract.action

Description

Detailed codes for the contract action.

Details: SNOMED CT
System: http://snomed.info/sct

Supported Values

441898007 - Consented (qualifier value)

Contract.actionReason

Description

Detailed codes for the contract action reason.

Details: SNOMED CT
System: http://snomed.info/sct

Supported Values

425691002 - Consent given for electronic record sharing (finding)

Contract.actor.role

Description

Detailed codes for the contract actor role.

Details: SNOMED CT
System: http://snomed.info/sct

Supported Values

442681007 - Recipient consented (qualifier value)

Search

Search for Contracts that meet supplied query parameters:

GET /Contract?:parameters

Authorization Types

Provider | Patient | System

Parameters

Name	Required?	Type	Description
`_id`	No, if populated all other parameters are ignored	`token`	The logical resource id associated with the resource.
`actor`	Yes, or `_id`	`reference`	The actor (RelatedPerson) of the Contract. Example: `actor=RelatedPerson/1234` or `actor:RelatedPerson=1234`
`actor.identifier`	Yes, or `_id`	`token`	The identifier for the actor of the Contract. Example `actor.identifier=system\|1234`
`patient.identifier`	Yes, or `_id`	`token`	The identifier for the patient subject of the Contract. Example `patient.identifier=system\|5678`
`subject`	Yes, or `_id`	`reference`	The subject (Patient) of the Contract. Example `subject=Patient/1234` or `subject:Patient=1234`
`_include`	No	`string`	Other resource entries to be returned as part of the bundle. Example `_include=Contract:actor` or `_include=Contract:patient`

Notes:

Either the _id or one of actor, actor.identifier, patient.identifier, or subject parameters must be provided.
The actor, actor.identifier, patient.identifier, or subject parameters may be provided exactly once and may have only a single value.
The _include parameter may be provided once for each resource to be included. 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.

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

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

Response

Status: 200 OK

{
  "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"
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Example with Include

Request

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

Response

Status: 200 OK

{
  "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"
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Retrieve by id

List an individual Contract by its id:

GET /Contract/:id

Authorization Types

Provider | Patient | System

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Contract/490068369

Response

Status: 200 OK

{
  "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"
        }
      ]
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Millennium

Contract

Overview

Terminology Bindings

Search

Authorization Types

Parameters

Headers

Example

Request

Response

Example with Include

Request

Response

Errors

Retrieve by id

Authorization Types

Headers

Example

Request

Response

Errors

DSTU 2 Overview

Conformance

Care Provision

Diagnostic

Devices

Encounters

Entities

General Clinical

Infrastructure

Individuals

Medications

Scheduling