EV Web API

DocumentReference

Description: Reference to a CDA document.

Reference: DocumentReference in FHIR specification.

Search

Search Parameters:

Name	Type	Required	Description
date	date	False	Date/time of the DocumentReference.
encounter	reference	True	Which ED visit the DocumentReference is for.
patient	reference	True	Who the DocumentReference is for.
subject	reference	True	Who the DocumentReference is for.
type	string	False	Type of document. Specified using the LOINC code. (Continuity of Care Document=34133-9, Referral Note=57133-1, Discharge Summary=18842-5)

* Required search parameters - encounter, patient, or subject

DateIncluded= True

* See Date Search for more information on searching by date.

Sample Request:

GET https://greathospital.com:8100/r4/sites/123/DocumentReference?patient=1

Read

Sample Request:

GET https://greathospital.com:8100/r4/sites/123/DocumentReference/1

Add

Sample Request:

POST https://greathospital.com:8100/r4/sites/123/DocumentReference

Body:

{
    "resourceType": "DocumentReference",
    "text": {
        "status": "generated",
        "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>DocumentReference</b></p><p><b>Master Identifier:</b>: e84d5a42-dac7-4bd1-8cc2-e3327e25360f</p><p><b>Identifier:</b> cd47ed6c-32d5-4ed8-ba95-8776333efac3</p><p><b>Subject:</b> MANDILE, Malcom</p><p><b>Type:</b> <p><b>Text</b>: Summary of Episode Note</p><p><b>System</b>: http://loinc.org</p><p><b>Code</b>: 34133-9</p><p><b>Display</b>: Summary of Episode Note</p></p><p><b>Class:</b> <p><b>Text</b>: Summary of Episode Note</p><p><b>System</b>: http://loinc.org</p><p><b>Code</b>: 34133-9</p><p><b>Display</b>: Summary of Episode Note</p></p><p><b>Author:</b> T System EV (5.1), T-System Medical Center 123</p><p><b>Created:</b> 2019-02-06T13:48:23+00:00</p><p><b>Status:</b> Current</p><p><b>Doc Status:</b> Preliminary</p></div>"
    },
    "status": "current",
    "docStatus": "preliminary",
    "type": {
        "coding": [{
            "system": "http://loinc.org",
            "code": "34133-9",
            "display": "Summary of Episode Note"
        }],
        "text": "Summary of Episode Note"
    },
    "category": {
        "coding": [{
            "system": "http://loinc.org",
            "code": "34133-9",
            "display": "Summary of Episode Note"
        }],
        "text": "Summary of Episode Note"
    },
    "subject": {
        "reference": "https://greathospital.com:8100/r4/sites/123//sites/234/Patient/145",
        "display": "MANDILE, Malcom"
    },
    "date": "2019-02-06T13:48:23+00:00",
    "author": [{
        "reference": "https://greathospital.com:8100/r4/sites/123//sites/234/Practitioner/4A618914-BCF9-4587-AFCD-68BDCD943170",
        "display": "Feltner, Chuck"
    }],
    "content": [{
        "attachment": {
            "contentType": "application/xhtml+xml;charset=utf-8",
            "data": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KICAgIDwhRE9DVFlQRSBodG1sIFBVQkxJQyAiLS8vVzNDLy9EVEQgWEhUTUwgMS4wIFN0cmljdC8vRU4iCiAgICAgICAgImh0dHA6Ly93d3cudzMub3JnL1RSL3hodG1sMS9EVEQveGh0bWwxLXN0cmljdC5kdGQiPgogICAgIDxodG1sIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hodG1sIiB4bWw6bGFuZz0iZW4iIGxhbmc9ImVuIj4KICAgICA8aGVhZD4KICAgICAgIDx0aXRsZT5DRFMgU3VtbWFyeTwvdGl0bGU+CiAgICAgICA8bWV0YSBodHRwLWVxdWl2PSJDb250ZW50LVR5cGUiIGNvbnRlbnQ9ImFwcGxpY2F0aW9uL3hodG1sK3htbDsgY2hhcnNldD1VVEYtOCIgLz4KICAgICAgIDxtZXRhIGh0dHAtZXF1aXY9IkNvbnRlbnQtU3R5bGUtVHlwZSIgY29udGVudD0idGV4dC9jc3MiIC8+CiAgICAgPC9oZWFkPgogICAgIDxib2R5PgogICAgICA8ZGl2PgogICAgICAgIDxoMT5FdmlkZW5jZSBDYXJlIC0tIENEUyBTdW1tYXJ5PC9oMT4KICAgICAgICAgPGRpdj48aDI+VGhlIHBhdGllbnQgd2FzIGV2YWx1YXRlZCBhbmQgdHJlYXRlZCBmb3IgdGhlIGZvbGxvd2luZyBjb25kaXRpb24ocyk6PC9oMj4gPHVsPjxsaT5JbmZsdWVuemE8L2xpPjwvdWw+IDwvZGl2PiA8ZGl2PjxoMz5UcmVhdG1lbnQ8L2gzPgogICAgICAgIAogICAgICAKICAgICAgPHA+LVRoZSBwYXRpZW50IHJlY2VpdmVkIGEgZGlzY2hhcmdlIHByZXNjcmlwdGlvbiBmb3IgYW4gYW50aXZpcmFsIG1lZGljYXRpb24uPC9wPiAgCiAgICAgIAogICAgCiAgICAgIDwvZGl2PjxkaXY+PGgzPkFzc2Vzc21lbnQ8L2gzPgogICAgICAgIAogICAgICAKICAgICAgPHA+LVRoZSBwYXRpZW50IHdhcyBkZXRlcm1pbmVkIHRvIGhhdmUgaW5mbHVlbnphLjwvcD4gIAogICAgICAKICAgIAogICAgICAKICAgICAgPHA+LVBhdGllbnQgcmVwb3J0cyBjb3VnaCBkdXJhdGlvbiBsZXNzIHRoYW4gNCB3ZWVrcy48L3A+ICAKICAgICAgCiAgICAKICAgICAgCiAgICAgIDxwPi1UaGUgcGF0aWVudCBoYXMgc2lnbnMgYW5kIHN5bXB0b21zIHRoYXQgbWF5IGluZGljYXRlIGEgbW9yZSBzZXJpb3VzIGNvbmRpdGlvbiByZXF1aXJpbmcgdXJnZW50IGludGVydmVudGlvbi48L3A+ICAKICAgICAgCiAgICAKICAgICAgPC9kaXY+PGRpdj48aDM+RGlhZ25vc3RpYzwvaDM+CiAgICAgICAgCiAgICAgIAogICAgICA8cD4tQSBjaGVzdCBYLXJheSAoUEEvTEFUKSB3YXMgb3JkZXJlZC48L3A+ICAKICAgICAgCiAgICAKICAgICAgCiAgICAgIDxwPi1BIHJhcGlkIGZsdSB0ZXN0IHdhcyBvcmRlcmVkLjwvcD4gIAogICAgICAKICAgIAogICAgICA8L2Rpdj48ZGl2PjxoMz5DYXJlIFRyYW5zaXRpb248L2gzPgogICAgICAgIAogICAgICAKICAgICAgPHA+LUEgdGVsZS1jb25zdWx0IHdhcyBvYnRhaW5lZDwvcD4gIAogICAgICAKICAgIAogICAgICAKICAgICAgPHA+LUNvbnRpbnVlIGNhcmUgYXQgUHJvbXB0Q2FyZTwvcD4gIAogICAgICAKICAgIAogICAgICA8L2Rpdj4gPGRpdj48aDM+MS4gPC9oMz4gPHA+LSAoWWVzKSBTcE8yICZsdDsgOTMlIG9uIHJvb20gYWlyLCBubyByZXNwb25zZSB0byBveHlnZW4gKzEgPC9wPiA8cD4tIChObykgSGVtb3B0eXNpcyArMSA8L3A+IDxwPi0gKFllcykgV2VpZ2h0IGxvc3MgKzEgPC9wPiA8cD4tIChObykgRmV2ZXIgJmd0OyAxMDTCsCBGICsxIDwvcD4gPHA+LSAoWWVzKSBIaWdoIHJpc2sgb3IgcHJldmlvdXNseSBkaWFnbm9zZWQgdHViZXJjdWxvc2lzICsxIDwvcD48L2Rpdj4KICAgICAgPC9kaXY+CiAgICAgPC9ib2R5PgogICAgPC9odG1sPg=="
        }
    }],
    "context": {
        "encounter": {
            "reference": "https://greathospital.com:8100/r4/sites/123//sites/234/Encounter/c95ea99e-69fa-4758-b7f2-b4be5dde68ee",
            "display": "Id:36b39f16-7787-4b62-a027-54878d73b715 (MANDILE, Malcom)"
        }
    }
}

Delete

Sample Request:

DELETE https://greathospital.com:8100/r4/sites/123/DocumentReference/1

Update

Sample Request:

PUT https://greathospital.com:8100/r4/sites/123/DocumentReference