ProviderConnect Patient Admitted Message
Draft
This is draft documentation for proposed functionality.
STATUS: draft
This message is used by contracted providers to notify their health plan or managed care organization of a patient admission.
{
// ...
"eventCoding": {
"system": "http://ntst.com/fhir/message-events",
"code": "pc-patient-admitted"
}
// ...
}
Authorization
This message will require the application obtain authorization using one of the following custom scopes based on SMART.
- v1:
[patient|user|system]/Messaging.[write|*] - v2: To be determined. (future)
Workflow
Payload
The payload for this message will consist of a Bundle with the type message and additional resources that make up the relevant information for the Service Request.
| Resource | Cardinality | Note |
|---|---|---|
| MessageHeader | 1..1 | Required for all FHIR messages and must be the first entry in the Bundle. |
| Encounter | 1..1 | Details of the admission. |
| Patient | 1..1 | The patient admitted. |
| Condition | 0..* | Conditions this admission will address or are relevant to treatment. Any Conditions not referenced by the Encounter should be listed in MessageHeader.focus since they are not referenced elsewhere in the Bundle. |
| Coverage | 0..* | Associated insurance coverage for this admission. These should be listed in MessageHeader.focus since they are not referenced elsewhere in the Bundle. |
| Observation | 0..* | Observations relevant to this admission. These should be listed in MessageHeader.focus since they are not referenced elsewhere in the Bundle. |
| QuestionnaireResponse | 0..* | Supporting information for the admission. These should be listed in MessageHeader.focus since they are not referenced elsewhere in the Bundle. |
| RelatedPerson | 0..* | Persons related to the patient. These should be listed in MessageHeader.focus since they are not referenced elsewhere in the Bundle. |
Entity Relationship Diagram
Each resource included in the reference must be referenced by another resource within the Bundle. The diagram below illustrates the relationships and references.
Examples
Sample Request Payload
{
"resourceType": "Bundle",
"id": "607e4728-5d96-43a8-8be0-418313050140",
"type": "message",
"entry": [
{
"fullUrl": "urn:uuid:267b18ce-3d37-4581-9baa-6fada338038b",
"resource": {
"resourceType": "MessageHeader",
"eventCoding": {
"system": "http://ntst.com/fhir/message-events",
"code": "pc-patient-admitted"
},
"focus": [
{
"reference": "Encounter/29f783df-d512-4eaa-93ff-946d5c8f6c54",
"type": "Encounter"
},
{
"reference": "QuestionnaireResponse/ABC-456789",
"type": "QuestionnaireResponse"
}
]
}
},
{
"fullUrl": "urn:uuid:29f783df-d512-4eaa-93ff-946d5c8f6c54",
"resource": {
"resourceType": "Encounter",
"id": "29f783df-d512-4eaa-93ff-946d5c8f6c54",
"extension": [
// We can support multiple extension data types via the message. However, these will only be read if configured in Referral Manager.
],
"identifier": [
// We can support the exchange of identifiers as well. Configure the Systems in Referral Manager to add to the Referral.
],
// to be written
}
},
{
"fullUrl": "Patient/987654",
"resource": {
"resourceType": "Patient",
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White"
}
},
{
"url": "detailed",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White"
}
},
{
"url": "text",
"valueString": "White"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Not Hispanic or Latino"
}
},
{
"url": "detailed",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Not Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Not Hispanic or Latino"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "M"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-citizenship",
"extension": [
{
"url": "code",
"valueCodeableConcept": {
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
},
{
"url": "code",
"valuePeriod": {
"start": "2000-03-12T05:00:00+00:00",
"end": "2017-08-31T05:00:00+00:00"
}
}
]
}
],
"identifier": [
// Supported
],
"name": [
{
"text": "First MI Last",
"family": "Last",
"given": [
"First",
"MI"
],
"suffix": "JR"
}
],
"telecom": [
{
"use": "home",
"system": "phone",
"value": "5556667788",
"rank": 1
},
{
"use": "work",
"system": "phone",
"value": "5556321478"
},
{
"use": "home",
"system": "email",
"value": "myemail20004@gmail.com"
}
],
"gender": "male",
"birthDate": "1997-01-16",
"deceasedBoolean": false,
"address": [
{
"use": "home",
"line": [
"4950 College Blvd."
],
"city": "Overland Park",
"state": "KS",
"postalCode": "66211",
"country": "US",
"period": {
"start": "2015-06-22T05:00:00+00:00"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "urn:oid:2.16.840.1.113883.4.642.3.29",
"code": "C",
"display": "Common Law"
}
]
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:oid:1.0.639.1",
"code": "en",
"display": "English"
}
]
},
"preferred": true
}
]
}
},
{
"fullUrl": "urn:uuid:cc9d50ce-0788-4df1-a753-53e5bd6416cd",
"resource": {
"resourceType": "Condition",
"id": "cc9d50ce-0788-4df1-a753-53e5bd6416cd",
// to be written
}
},
{
"fullUrl": "urn:uuid:e151905e-cd8b-4c40-aa9b-8c49225a9771",
"resource": {
"resourceType": "Coverage",
"id": "e151905e-cd8b-4c40-aa9b-8c49225a9771",
// to be written
}
},
{
"fullUrl": "urn:uuid:00abd131-3870-4fb6-9bd3-aab60bb3e561",
"resource": {
"resourceType": "Observation",
"id": "00abd131-3870-4fb6-9bd3-aab60bb3e561",
// to be written
}
},
{
"fullUrl": "QuestionnaireResponse/ABC-456789",
"resource": {
"resourceType": "QuestionnaireResponse",
"identifier": {
"value": "MQ_3641833"
},
"basedOn": [
{
"reference": "ServiceRequest/123456"
}
],
"questionnaire": "Questionnaire/ABC",
"status": "in-progress",
"item": [
{
"linkId": "P-01",
"text": "Text of the first prompt?",
"answer": [
{
"valueString": "Free-text answer"
}
]
},
{
"linkId": "P-02",
"text": "Text the second prompt?",
"answer": [
{
"valueBoolean": false
}
]
}
]
}
},
{
"fullUrl": "urn:uuid:00abd131-3870-4fb6-9bd3-aab60bb3e561",
"resource": {
"resourceType": "RelatedPerson",
"id": "00abd131-3870-4fb6-9bd3-aab60bb3e561",
// to be written
}
}
]
}
Sample Response Payload
{
"resourceType": "Bundle",
"id": "1a124350-e357-4b29-b780-1a4c9064c024",
"type": "message",
"entry": [
{
"fullUrl": "urn:uuid:267b18ce-3d37-4581-9baa-6fada338038b",
"resource": {
"resourceType": "MessageHeader",
"eventCoding": {
"system": "http://ntst.com/fhir/message-events",
"code": "pc-patient-admitted"
},
"response": {
"identifier": "607e4728-5d96-43a8-8be0-418313050140",
"code": "ok"
},
"focus": [
{
"reference": "Encounter/29f783df-d512-4eaa-93ff-946d5c8f6c54",
"type": "Encounter"
},
{
"reference": "QuestionnaireResponse/ABC-456789",
"type": "QuestionnaireResponse"
}
]
}
},
// To be written
]
}