Request OnCall Communication

 
CareSpan Required fieldsDetail fields List

Name Field Name Type Value Description Required
Practitioner ID recipient.reference - Practitioner/GLV5Z14OI3 Practitioner ID. Yes
Patient MRN subject.reference - Patient/GPEI9SK8VF Patient MRN Yes
Category category.coding.code - notification Category Code (only support notification) Yes
Payload Type payload.contentReference.value - request Communication Type (only support request) Yes
Payload Text payload.contentReference.contentString - Text Notification
Communication Content
If type is request, this will be the "Reason For Visit"
Yes

Request Type

POST


Request URL

https://test-api.carespan.clinic/R4/Communication

Request Json
        
{
    "resourceType": "Communication",
    "recipient": [
        {
            "reference": "Practitioner/GLV5Z14OI3"
        }
    ],
    "subject": {
        "reference": "Patient/GPEI9SK8VF"
    },
    "category": [
        {
            "coding": [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/communication-category",
                    "code": "notification"
                }
            ],
            "text": "Notification"
        }
    ],
    "payload": [
        {
            "contentString": "Patient is Requesting for an exam session"
        },
        {
            "contentReference": {
                "system": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-communicationType",
                "value": "request"
            }
        }
    ]
}
        
        

Response Json
        
{
    "resourceType": "Communication",
    "recipient": [
        {
            "reference": "Practitioner/GLV5Z14OI3"
        }
    ],
    "subject": {
        "reference": "Patient/GPEI9SK8VF"
    },
    "category": [
        {
            "coding": [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/communication-category",
                    "code": "notification"
                }
            ],
            "text": "Notification"
        }
    ],
    "payload": [
        {
            "contentString": "Patient is Requesting for an exam session"
        },
        {
            "contentReference": {
                "system": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-communicationType",
                "value": "request"
            }
        }
    ]
}