Contract

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 for Contracts that meet supplied query parameters:

GET /Contract?:parameters

Authorization Types

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:

Headers

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

Example

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Contract?subject:Patient=4598008

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "b5c1e566-ba97-4523-b113-83d1125e7d1d",
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Contract?subject=Patient%2F4598008"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Contract/7470218",
      "resource": {
        "resourceType": "Contract",
        "id": "7470218",
        "meta": {
          "versionId": "2"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Contract</b></p><p><b>Actor Name</b>: NOAH, GEORGE</p><p><b>Subject Name</b>: NOAH, BRANDON</p><p><b>Applies Begin</b>: Tue Nov  8 21:09:24 2016 (UTC)</p><p><b>Type</b>: Consent report (record artifact)</p><p><b>Subtype</b>: Consent status (finding)</p></div>"
        },
        "applies": {
          "start": "2016-11-08T21:09:24.000Z"
        },
        "subject": [
          {
            "reference": "Patient/4598008",
            "display": "NOAH, BRANDON"
          }
        ],
        "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/7470218",
              "display": "NOAH, GEORGE"
            },
            "role": [
              {
                "text": "Authorized Representative"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Contract/7470237",
      "resource": {
        "resourceType": "Contract",
        "id": "7470237",
        "meta": {
          "versionId": "1"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Contract</b></p><p><b>Actor Name</b>: NOAH, SANDY</p><p><b>Subject Name</b>: NOAH, BRANDON</p><p><b>Applies Begin</b>: Tue Nov  8 21:15:10 2016 (UTC)</p><p><b>Type</b>: Consent report (record artifact)</p><p><b>Subtype</b>: Consent status (finding)</p></div>"
        },
        "applies": {
          "start": "2016-11-08T21:15:10.000Z"
        },
        "subject": [
          {
            "reference": "Patient/4598008",
            "display": "NOAH, BRANDON"
          }
        ],
        "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/7470237",
              "display": "NOAH, SANDY"
            },
            "role": [
              {
                "text": "Authorized Representative"
              }
            ]
          }
        ]
      }
    }
  ]
}

Example with Include

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Contract?subject=Patient%2F4598008&_include=Contract%3Aactor

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "ce512c79-4aed-41cf-b617-bcf969ae657a",
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Contract?subject=Patient%2F4598008&_include=Contract%3Aactor"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Contract/7470218",
      "resource": {
        "resourceType": "Contract",
        "id": "7470218",
        "meta": {
          "versionId": "2"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Contract</b></p><p><b>Actor Name</b>: NOAH, GEORGE</p><p><b>Subject Name</b>: NOAH, BRANDON</p><p><b>Applies Begin</b>: Tue Nov  8 21:09:24 2016 (UTC)</p><p><b>Type</b>: Consent report (record artifact)</p><p><b>Subtype</b>: Consent status (finding)</p></div>"
        },
        "applies": {
          "start": "2016-11-08T21:09:24.000Z"
        },
        "subject": [
          {
            "reference": "Patient/4598008",
            "display": "NOAH, BRANDON"
          }
        ],
        "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/7470218",
              "display": "NOAH, GEORGE"
            },
            "role": [
              {
                "text": "Authorized Representative"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Contract/7470237",
      "resource": {
        "resourceType": "Contract",
        "id": "7470237",
        "meta": {
          "versionId": "1"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Contract</b></p><p><b>Actor Name</b>: NOAH, SANDY</p><p><b>Subject Name</b>: NOAH, BRANDON</p><p><b>Applies Begin</b>: Tue Nov  8 21:15:10 2016 (UTC)</p><p><b>Type</b>: Consent report (record artifact)</p><p><b>Subtype</b>: Consent status (finding)</p></div>"
        },
        "applies": {
          "start": "2016-11-08T21:15:10.000Z"
        },
        "subject": [
          {
            "reference": "Patient/4598008",
            "display": "NOAH, BRANDON"
          }
        ],
        "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/7470237",
              "display": "NOAH, SANDY"
            },
            "role": [
              {
                "text": "Authorized Representative"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/RelatedPerson/7470237",
      "resource": {
        "resourceType": "RelatedPerson",
        "id": "7470237",
        "meta": {
          "versionId": "1"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>RelatedPerson</b></p><p><b>Name</b>: NOAH, SANDY</p><p><b>DOB</b>: 1974-11-08</p><p><b>Sex</b>: Female</p></div>"
        },
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/v2/0203",
                  "code": "AN",
                  "display": "Account number",
                  "userSelected": false
                }
              ],
              "text": "Federated Person Principal"
            },
            "system": "urn:oid:2.16.840.1.113883.3.13.6",
            "value": "URN:CERNER:IDENTITY-FEDERATION:REALM:6A2A9D0D-C19E-4B52-BB97-22732FDAA8D6:PRINCIPAL:A50B81F9AD",
            "period": {
              "start": "2016-01-02T05:00:00.000Z",
              "end": "2017-01-02T05:00:00.000Z"
            }
          }
        ],
        "patient": {
          "reference": "Patient/4598008",
          "display": "NOAH, BRANDON"
        },
        "relationship": {
          "text": "Son"
        },
        "name": {
          "use": "official",
          "text": "NOAH, SANDY",
          "family": [
            "NOAH"
          ],
          "given": [
            "SANDY"
          ],
          "period": {
            "start": "2016-11-08T21:13:57.000Z"
          }
        },
        "gender": "female",
        "birthDate": "1974-11-08",
        "period": {
          "start": "2016-11-08T21:15:10.000Z"
        }
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/RelatedPerson/7470218",
      "resource": {
        "resourceType": "RelatedPerson",
        "id": "7470218",
        "meta": {
          "versionId": "2"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>RelatedPerson</b></p><p><b>Name</b>: NOAH, GEORGE</p><p><b>DOB</b>: 1976-10-08</p><p><b>Sex</b>: Male</p></div>"
        },
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/v2/0203",
                  "code": "AN",
                  "display": "Account number",
                  "userSelected": false
                }
              ],
              "text": "Federated Person Principal"
            },
            "system": "urn:oid:2.16.840.1.113883.3.13.6",
            "value": "TEST_ALIAS_1"
          }
        ],
        "patient": {
          "reference": "Patient/4598008",
          "display": "NOAH, BRANDON"
        },
        "relationship": {
          "text": "Son"
        },
        "name": {
          "use": "official",
          "text": "NOAH, GEORGE",
          "family": [
            "NOAH"
          ],
          "given": [
            "GEORGE"
          ],
          "period": {
            "start": "2016-11-08T21:08:05.000Z"
          }
        },
        "gender": "male",
        "birthDate": "1976-10-08",
        "period": {
          "start": "2016-11-08T21:09:24.000Z"
        }
      }
    }
  ]
}

Errors

The common errors may be returned.

Retrieve by id

List an individual Contract by its id:

GET /Contract/:id

Authorization Types

Headers

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

Example

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Contract/7470218

Response

Status: 200 OK
{
  "resourceType": "Contract",
  "id": "7470218",
  "meta": {
    "versionId": "2"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>Contract</b></p><p><b>Actor Name</b>: NOAH, GEORGE</p><p><b>Subject Name</b>: NOAH, BRANDON</p><p><b>Applies Begin</b>: Tue Nov  8 21:09:24 2016 (UTC)</p><p><b>Type</b>: Consent report (record artifact)</p><p><b>Subtype</b>: Consent status (finding)</p></div>"
  },
  "applies": {
    "start": "2016-11-08T21:09:24.000Z"
  },
  "subject": [
    {
      "reference": "Patient/4598008",
      "display": "NOAH, BRANDON"
    }
  ],
  "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/7470218",
        "display": "NOAH, GEORGE"
      },
      "role": [
        {
          "text": "Authorized Representative"
        }
      ]
    }
  ]
}

Errors

The common errors may be returned.