Telephonic Encounter
Terminology
Encounter Type
System | Code | Display |
---|---|---|
https://www.healthgorilla.com/fhir/encounter-type | telephonic-encounter | Telephonic Encounter |
Participant Type
System | Code | Display | Description |
---|---|---|---|
http://hl7.org/fhir/v3/ParticipationType | PPRF | Primary performer | Author |
https://www.healthgorilla.com/fhir/participation-type | assignee | Assignee | |
https://www.healthgorilla.com/fhir/participation-type | cc | CC User |
Encounter Processing Status
System: https://www.healthgorilla.com/fhir/encounter-processing-status
Code | Display |
---|---|
assigned | Assigned |
completed | Completed |
Reason code
System: https://www.healthgorilla.com/encounter-reason
Code | Display |
---|---|
billing | Billing |
refill-rx | Refill/Rx |
needs-callBack | Needs call back |
records-request | Records request |
insurance-updated | Insurance info updated |
copay | Copay |
results | Results |
second-call | Second call |
returned-call | Returned call |
school-work-excuse | School/work excuse |
urgent-visit-request | Urgent visit request |
phone-consult | Phone consult |
Profile and Extensions
Telephonic Encounter Profile
https://healthgorilla.com/fhir/StructureDefinition/hg-telephonic-encounter
Processing Status Extension
https://www.healthgorilla.com/fhir/StructureDefinition/encounter-processingStatus
{
"url": "https://www.healthgorilla.com/fhir/StructureDefinition/encounter-processingStatus",
"valueCoding": {
"system": "https://www.healthgorilla.com/fhir/encounter-processing-status",
"code": "completed",
"display": "Completed"
}
}
Note Extension
https://www.healthgorilla.com/fhir/StructureDefinition/encounter-note
{
"url": "https://www.healthgorilla.com/fhir/StructureDefinition/encounter-note",
"valueString": "Your note here"
}
Action Taken
https://www.healthgorilla.com/fhir/StructureDefinition/encounter-actionTaken
Parameter | Type | Details |
---|---|---|
date | datetime | The timestamp |
performer | reference | Reference to the practitioner. |
note | string | Text |
An action that has already been taken
{
"url": "https://www.healthgorilla.com/fhir/StructureDefinition/encounter-actionTaken",
"extension": [
{
"url": "date",
"valueDateTime": "2020-10-12T17:08:14+03:00"
},
{
"url": "performer",
"valueReference": {
"reference": "Practitioner/ceda4352e8f6405dd2e42f09",
"display": "John Doe, M.D., Sacred Health Hospital"
}
},
{
"url": "note",
"valueString": "Reassigned this telephonic encounter to Elliot Reid, John Doe"
}
]
}
A new action to apply (create/update)
parameter | Details |
---|---|
date | skipped |
performer | Optional |
note | Required |
{
"url": "https://www.healthgorilla.com/fhir/StructureDefinition/encounter-actionTaken",
"extension": [
{
"url": "performer",
"valueReference": {
"reference": "Practitioner/ceda4352e8f6405dd2e42f09",
"display": "John Doe, M.D., Sacred Health Hospital"
}
},
{
"url": "note",
"valueString": "Reassigned this telephonic encounter to Elliot Reid, John Doe"
}
]
}
Create new telephonic encounter
https://api.healthgorilla.com/fhir/Encounter
{
"resourceType": "Encounter",
"meta": {
"profile": ["https://healthgorilla.com/fhir/StructureDefinition/hg-telephonic-encounter"]
},
"extension": [
{
"url": "https://www.healthgorilla.com/fhir/StructureDefinition/encounter-note",
"valueString": "Created for testing purposes."
},
{
"url": "https://www.healthgorilla.com/fhir/StructureDefinition/encounter-processingStatus",
"valueCoding": {
"system": "https://www.healthgorilla.com/fhir/encounter-processing-status",
"code": "assigned",
"display": "Assigned"
}
},
{
"url": "https://www.healthgorilla.com/fhir/StructureDefinition/encounter-actionTaken",
"extension": [
{
"url": "performer",
"valueReference": {
"reference": "Practitioner/ceda4352e8f6405dd2e42f09",
"display": "John Doe (Sacred Health Hospital)"
}
},
{
"url": "note",
"valueString": "Assigned this telephonic encounter to Elliot Reid"
}
]
}
],
"status": "finished",
"class": {
"system": "http://hl7.org/fhir/v3/ActCode",
"code": "VR",
"display": "virtual"
},
"type": [
{
"coding": [
{
"system": "https://www.healthgorilla.com/fhir/encounter-type",
"code": "telephonic-encounter",
"display": "Telephonic Encounter"
}
],
"text": "Telephonic Encounter"
}
],
"subject": {
"reference": "Patient/03db43522cc01432572e0a53",
"display": "Bart Simpson"
},
"participant": [
{
"type": [
{
"coding": [
{
"system": "http://hl7.org/fhir/v3/ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
],
"text": "primary performer"
}
],
"individual": {
"reference": "Practitioner/ceda4352e8f6405dd2e42f09",
"display": "John Doe"
}
},
{
"type": [
{
"coding": [
{
"system": "https://www.healthgorilla.com/fhir/participation-type",
"code": "assignee",
"display": "Assignee"
}
],
"text": "Assignee"
}
],
"individual": {
"reference": "Practitioner/5e093356c06e5fec973c8e76",
"display": "Elliot Reid"
}
},
{
"type": [
{
"coding": [
{
"system": "https://www.healthgorilla.com/fhir/participation-type",
"code": "cc",
"display": "Carbon Copy"
}
],
"text": "Carbon Copy"
}
],
"individual": {
"reference": "Practitioner/fc076a524383b188ffc10051",
"display": "Robert Kelso"
}
}
],
"reason": [
{
"text": "Test"
}
]
}
Parameters:
Status: Assigned
Author: John Doe
Assignee: Elliot Reid
CC: Robert Kelso
Reason: Other(Test)
Note: Created for testing purposes.
Action Taken: Assigned this telephonic encounter to Elliot Reid
Update
You can modify:
- processing status (assigned -> completed)
- note
- assignee
- cc user
You can add:
- action taken
https://api.healthgorilla.com/fhir/Encounter/ENCOUNTER_ID
{
"resourceType": "Encounter",
"id": "te-777eeb5860a3973dda5b0a86",
"meta": {
"profile": ["https://healthgorilla.com/fhir/StructureDefinition/hg-telephonic-encounter"]
},
"extension": [
{
"url": "https://www.healthgorilla.com/fhir/StructureDefinition/encounter-note",
"valueString": "Created for testing purposes and then modified."
},
{
"url": "https://www.healthgorilla.com/fhir/StructureDefinition/encounter-processingStatus",
"valueCoding": {
"system": "https://www.healthgorilla.com/fhir/encounter-processing-status",
"code": "completed",
"display": "Completed"
}
},
{
"url": "https://www.healthgorilla.com/fhir/StructureDefinition/encounter-actionTaken",
"extension": [
{
"url": "performer",
"valueReference": {
"reference": "Practitioner/5e093356c06e5fec973c8e76",
"display": "Elliot Reid"
}
},
{
"url": "note",
"valueString": "Reassigned this telephonic encounter to John Doe"
}
]
}
],
"identifier": [
{
"system": "https://www.healthgorilla.com",
"value": "777eeb5860a3973dda5b0a86"
}
],
"status": "finished",
"class": {
"system": "http://hl7.org/fhir/v3/ActCode",
"code": "VR",
"display": "virtual"
},
"type": [
{
"coding": [
{
"system": "https://www.healthgorilla.com/fhir/encounter-type",
"code": "telephonic-encounter",
"display": "Telephonic Encounter"
}
],
"text": "Telephonic Encounter"
}
],
"subject": {
"reference": "Patient/03db43522cc01432572e0a53",
"display": "Bart Simpson"
},
"participant": [
{
"type": [
{
"coding": [
{
"system": "http://hl7.org/fhir/v3/ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
],
"text": "primary performer"
}
],
"individual": {
"reference": "Practitioner/ceda4352e8f6405dd2e42f09",
"display": "John Doe"
}
},
{
"type": [
{
"coding": [
{
"system": "https://www.healthgorilla.com/fhir/participation-type",
"code": "assignee",
"display": "Assignee"
}
],
"text": "Assignee"
}
],
"individual": {
"reference": "Practitioner/5e093356c06e5fec973c8e76",
"display": "Elliot Reid"
}
},
{
"type": [
{
"coding": [
{
"system": "https://www.healthgorilla.com/fhir/participation-type",
"code": "assignee",
"display": "Assignee"
}
],
"text": "Assignee"
}
],
"individual": {
"reference": "Practitioner/ceda4352e8f6405dd2e42f09",
"display": "John Doe"
}
},
{
"type": [
{
"coding": [
{
"system": "https://www.healthgorilla.com/fhir/participation-type",
"code": "cc",
"display": "Carbon Copy"
}
],
"text": "Carbon Copy"
}
],
"individual": {
"reference": "Practitioner/fc076a524383b188ffc10051",
"display": "Robert Kelso"
}
}
],
"period": {
"start": "2017-04-10T15:45:11+03:00"
},
"reason": [
{
"text": "Test"
}
]
}
Parameters:
Status: Completed
Author: John Doe
Assignee: Elliot Reid, John Doe
CC: Robert Kelso
Reason: Other(Test)
Note: Created for testing purposes and then modified.
Action Taken: Assigned this telephonic encounter to Elliot Reid
Action Taken: Reassigned this telephonic encounter to John Doe
Search by patient
Parameter | Type | Description |
---|---|---|
patient | reference | Reference to the patient |
type | token | https://www.healthgorilla.com/fhir/encounter-type%7Ctelephonic-encounter |
processing-status | token | Any code from https://www.healthgorilla.com/fhir/encounter-processing-status |
_lastUpdated | datetime |
Return all telephonic encounters for the patient with instance (logical) id 'd5da4352b3f978a445475a22'
https://api.healthgorilla.com/fhir/Encounter?patient=d5da4352b3f978a445475a22
&type=https://www.healthgorilla.com/fhir/encounter-type%7Ctelephonic-encounter
&_format=json
Lookup for assigned telephonic encpounters for the patient with global id 'd5da4352b3f978a445475a22'
https://api.healthgorilla.com/fhir/Encounter?patient.identifier=https://www.healthgorilla.com%7Cd5da4352b3f978a445475a22
&processing-status=assigned
&type=https://www.healthgorilla.com/fhir/encounter-type%7Ctelephonic-encounter
&_format=json
Search by last modified
Parameter | Type | Description |
---|---|---|
type | token | https://www.healthgorilla.com/fhir/encounter-type%7Ctelephonic-encounter |
processing-status | token | Any code from https://www.healthgorilla.com/fhir/encounter-processing-status |
_lastUpdated | datetime | |
_offset | number | |
_count | number |
Return all telephonic encounters updated since year 2019.
https://api.healthgorilla.com/fhir/Encounter?
type=https://www.healthgorilla.com/fhir/encounter-type%7Ctelephonic-encounter
&_lastUpdated=gt2019
&_format=json
Delete (archive)
https://api.healthgorilla.com/fhir/Encounter/ENCOUNTER_ID
6. PDF
https://api.healthgorilla.com/fhir/Encounter/ENCOUNTER_ID/$pdf
Example
https://api.healthgorilla.com/fhir/Encounter/te-2b56845fc3cfc79409dec5b8/$pdf
<Parameters xmlns="http://hl7.org/fhir">
<parameter>
<name value="url"/>
<valueString value="https://api.healthgorilla.com/fhir/Binary/tmp-2d5a855f4f78fc184e3d9ab8"/>
</parameter>
<parameter>
<name value="contentType"/>
<valueString value="application/pdf"/>
</parameter>
<parameter>
<name value="size"/>
<valuePositiveInt value="2427"/>
</parameter>
<parameter>
<name value="checksum"/>
<valueString value="f4a25fc5110d8f70b7b56838de338dcc"/>
</parameter>
<parameter>
<name value="expiredAt"/>
<valueDateTime value="2020-10-13T11:11:33+03:00"/>
</parameter>
</Parameters>
Updated 10 months ago