List of content:
Description:
The FHIR CommunicationRequest endpoint can be used to fetch information about claim feedback. The resource used by the ComunicationResponse to provide information about feedback. More information can be found here: openIMIS tblClaim resource (FHIR Claim / ClaimResponse)
Notes / Assumptions:
- The current version of an endpoint can be used only to fetching data
FHIR resources:
| CommunicationRequest | CommunicationRequest |
Fields mapping:
Table legend:
| Color | Description |
|---|---|
| Mapped - the final choice, the most suitable choice | |
| Need to be found the best place for the field (not mapped currently) | |
| Currently not important - not mapped |
CommunicationRequest mapping:
| OpenIMIS field | DB type | FHIR field | Note | STPH | Mapping status |
| FeedbackID | PK | identifier | Unique identifier | This is the Database ID and should be used only internally | |
| FeedbackUUID | uniqueidentifier | identifier | The unique identifier used as PK for FHIR | mapped | |
| ClaimID | FK(tblClaim) | - | The ClaimResponse has relation to feedback object | ||
| CareRendered | bit | reasonCode | mapped | ||
| PaymentAsked | bit | reasonCode | mapped | ||
| DrugPrescribed | bit | reasonCode | mapped | ||
| DrugReceived | bit | reasonCode | mapped | ||
| Asessment | tinyint | reasonCode | mapped | ||
| CHFOfficerCode | int | ||||
| FeedbackDate | datetime | occurrenceDateTime | mapped | ||
| ValidityFrom | datetime | ||||
| ValidityTo | datetime | ||||
| LegacyID | int | ||||
| AuditUserID | int |
Endpoint specification:
Example of endpoint URL:
http://127.0.0.1:8000/api_fhir/CommunicationRequest/
Supported HTTP operation:
CREATE - the operation currently not supported
- READ - by default return list of all available resources. To fetch information about a specific object you should add the primary key to URL for instance:
http://127.0.0.1:8000/api_fhir/Claim/{feedbackUUID}
, where "{feedbackUUID}" is the value of the primary key . Should be used the GET HTTP method. - UPDATE - the operation currently not supported
- DELETE - the operation currently not supported
Module configuration used by the endpoint:
| Configuration key | Description | Default value |
|---|---|---|
| stu3_fhir_identifier_type_config | configuration of system and codes used to represent the specific types of identifiers | "stu3_fhir_identifier_type_config":{ }, |
| stu3_fhir_communication_request_config | configuration of system and codes used to represent the specific codes for IMIS feedback attributes | "stu3_fhir_communication_request_config":{ "fhir_care_rendered_code":"care_rendered", "fhir_payment_asked_code":"payment_asked", "fhir_drug_prescribed_code":"drug_prescribed", "fhir_drug_received_code":"drug_received", "fhir_asessment_code":"asessment" } |
Example JSON representation of content:
{
"resourceType": "CommunicationRequest",
"id": "F719B223-83A7-44A1-8F21-7B80E5B9FDD0",
"identifier": [
{
"type": {
"coding": [
{
"code": "ACSN",
"system": "https://hl7.org/fhir/valueset-identifier-type.html"
}
]
},
"use": "usual",
"value": "F719B223-83A7-44A1-8F21-7B80E5B9FDD0"
}
],
"occurrenceDateTime": "2019-10-24T00:00:00",
"reasonCode": [
{
"coding": [
{
"code": "care_rendered"
}
],
"text": "False"
},
{
"coding": [
{
"code": "payment_asked"
}
],
"text": "True"
},
{
"coding": [
{
"code": "drug_prescribed"
}
],
"text": "True"
},
{
"coding": [
{
"code": "drug_received"
}
],
"text": "True"
},
{
"coding": [
{
"code": "asessment"
}
],
"text": "1"
}
],
"status": "unknown"
}