Allergy Intolerance

Description:


A record of a clinical assessment of an allergy or intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance.

This profile is used to define the content returned by the API Server in response to different search requests like ID & by patient to access AllergyIntolerance resources.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL -  /mps/fhir/R4/AllergyIntolerance/AllergyIntolerance-482

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID(string) The Resource ID of the AllergyIntolerance resource. Required



1.2.   Response


{

    "resourceType": "AllergyIntolerance",

    "id": "AllergyIntolerance-85-22",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"

        ]

    },

    "clinicalStatus": {

        "coding": [

            {

                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",

                "code": "active",

                "display": "Active"

            }

        ]

    },

    "verificationStatus": {

        "coding": [

            {

                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",

                "code": "confirmed"

            }

        ]

    },

    "code": {

        "coding": [

            {

                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",

                "code": "unknown"

            }

        ],

        "text": "ALLERGY TO FOOD"

    },

    "patient": {

        "reference": "Patient/85"

    },

    "reaction": [

        {

            "manifestation": [

                {

                    "coding": [

                        {

                            "system": "http://snomed.info/sct",

                            "code": "135882008",

                            "display": "Feverish cold (finding)"

                        }

                    ]

                }

            ]

        }

    ]

}



Name Description Required/Optional
AllergyIntolerance A single AllergyIntolerance resource Required


Allergy Intolerance Resource Content:


Name Description Required/Optional

clinicalStatus (CodeableConcept)

The current status of the allergy. Possible values include:

  • active
  • resolved
  • inactive

Required

The AllergyIntolerance FHIR ID.

Required

verificationStatus (CodeableConcept)

If the allergy is on the patient's chart, this element specifies "confirmed". If it is a newly created allergy and still needs to be reconciled, it is "unconfirmed".

Required

The allergen name and codes.

Required

Reference to a patient resource for whom the allergy is relevant.

Required

Reaction name

Required

Name Description Description
clinicalStatus (CodeableConcept) The current status of the allergy. Possible values include: active, resolved, and inactive Required
Id (String) The AllergyIntolerance FHIR ID. Required
verificationStatus (CodeableConcept) If the allergy is on the patient's chart, this element specifies "confirmed". If it is a newly created allergy and still needs to be reconciled, it is "unconfirmed". Required
code (CodeableConcept) The allergen name and codes. Required
patient(reference) Reference to a patient resource for whom the allergy is relevant. Required
reaction(CodeableConcept) Reaction name Required


Response Codes:


Response Code

Description

200 OK

The requested resource was found and is contained within the body of  the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Response Code

Description

Required/Optional

Resource ID (string)

The Resource ID of the AllergyIntolerance resource.

Required

Patient ID(reference)

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

The Resource ID of the AllergyIntolerance resource.


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "e7891e28-22a5-48ef-8e1d-d3100e85aa37",

    "meta": {

        "lastUpdated": "2022-11-18T14:25:53.528+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/AllergyIntolerance?_id=AllergyIntolerance-85-18"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "AllergyIntolerance",

                "id": "AllergyIntolerance-85-18",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"

                    ]

                },

                "clinicalStatus": {

                    "coding": [

                        {

                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",

                            "code": "active",

                            "display": "Active"

                        }

                    ]

                },

                "verificationStatus": {

                    "coding": [

                        {

                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",

                            "code": "confirmed"

                        }

                    ]

                },

                "code": {

                    "coding": [

                        {

                            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",

                            "code": "1292899",

                            "display": "penicillin G"

                        }

                    ]

                },

                "patient": {

                    "reference": "Patient/85"

                },

                "reaction": [

                    {

                        "manifestation": [

                            {

                                "coding": [

                                    {

                                        "system": "http://snomed.info/sct",

                                        "code": "315256004",

                                        "display": "Itching of pigmented skin lesion (disorder)"

                                    }

                                ]

                            }

                        ]

                    }

                ]

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

A single AllergyIntollerance resource.

Required

Allergy Intolerance Resource Content:

Name Description Required/Optional
clinicalStatus (CodeableConcept) The current status of the allergy. Possible values include: active, resolved, inactive Required
Id (string) The AllergyIntolerance FHIR ID. Required
verificationStatus (CodeableConcept) If the allergy is on the patient's chart, this element specifies "confirmed". If it is a newly created allergy and still needs to be reconciled, it is "unconfirmed". Required
code (CodeableConcept) The allergen name and codes. Required
patient(reference) Reference to a patient resource for whom the allergy is relevant. Required
reaction(CodeableConcept) Reaction name Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

clinicalStatus (CodeableConcept)

The current status of the allergy. Possible values include:

  • active
  • resolved
  • inactive

Required

Id (string)

The AllergyIntolerance FHIR ID.

Required

verificationStatus (CodeableConcept)

If the allergy is on the patient's chart, this element specifies "confirmed". If it is a newly created allergy and still needs to be reconciled, it is "unconfirmed".

Required

The allergen name and codes.

Required

Reference to a patient resource for whom the allergy is relevant.

Required

Reaction name

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of  the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Patient

Description:


The FHIR patient resource defines demographics and other administrative information about a person receiving care at a health organization.

In order to match and deliver a patient search request, one of the following minimal data sets is required by default.

  • ID 
  • Name 
  • Identifier
  • Birth date and name
  • Gender and name


Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL -  /mps/fhir/R4/Patient/85

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Response Code Description Required/Optional
Resource ID (string) The FHIR ID of the patient resource. Required

Response Code

Description

Required/Optional

Resource ID (string)

The FHIR ID of the patient resource.

Required



1.2.   Response

 

{

    "resourceType": "Patient",

    "id": "85",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-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": "text",

                    "valueString": "race"

                }

            ]

        },

        {

            "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": "Non - Hispanic/Latino"

                    }

                },

                {

                    "url": "text",

                    "valueString": "ethnicity"

                }

            ]

        },

        {

            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",

            "valueCode": "UNK"

        }

    ],

    "identifier": [

        {

            "type": {

                "coding": [

                    {

                        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",

                        "code": "SS"

                    }

                ]

            },

            "system": "http://hl7.org/fhir/sid/us-ssn",

            "value": "946481516"

        }

    ],

    "active": true,

    "name": [

        {

            "text": "Tejas",

            "family": "Test5",

            "given": [

                "Tejas",

                "G"

            ],

            "suffix": [

                "Jr"

            ]

        },

        {

            "text": "Tejas",

            "family": "Test1",

            "given": [

                "Tejas",

                "G"

            ],

            "period": {

                "start": "2022-11-09T05:00:18+00:00",

                "end": "2022-11-09T05:26:42+00:00"

            }

        },

        {

            "text": "Tejas",

            "family": "Test3",

            "given": [

                "Tejas",

                "G"

            ],

            "period": {

                "start": "2022-11-09T05:26:42+00:00"

            }

        }

    ],

    "telecom": [

        {

            "system": "phone",

            "value": "(555)-723-1544",

            "use": "home"

        },

        {

            "system": "phone",

            "value": "(555)-777-1234",

            "use": "mobile"

        }

    ],

    "gender": "male",

    "birthDate": "2013-07-31",

    "address": [

        {

            "line": [

                "1357, Amber Dr, Beaverton"

            ],

            "city": "Beaverton",

            "state": "OR",

            "postalCode": "3"

        },

        {

            "line": [

                "1357, Amber Dr, Beaverton"

            ],

            "city": "Beaverton",

            "state": "OR",

            "postalCode": "3",

            "period": {

                "start": "2022-11-09T05:00:18+00:00"

            }

        }

    ],

    "maritalStatus": {

        "coding": [

            {

                "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",

                "code": "M",

                "display": "Married"

            }

        ]

    },

    "communication": [

        {

            "language": {

                "coding": [

                    {

                        "system": "urn:ietf:bcp:47",

                        "code": "eng",

                        "display": "English"

                    }

                ]

            }

        }

    ]

}



Name

Description

Required/Optional

A single instance of patient resource.

Required

Name Description Required/Optionalription
Patient A single instance of patient resource. Required


Patient Resource Content:


Name

Description

Required/Optional

The AllergyIntolerance FHIR ID.

Required

active (Boolean)

If the patient record is active or inactive.

(True & False)

Required

address(Address)

The address of the patient.

Required

birthDate (date)

Date (MM-DD-YYYY) of the patient.

Required

Communication (BackboneElement)

A list of languages used to communicate with the patient, along with an indicator of which is preferred.

Required

contact (BackboneElement)

Patient Contact details.

Required

gender (code)

Patient legal Sex.

Required

race (Extension)

Patient Race.

Required

telecom (ContactPoint)

Patient telecom details.

Required

ethnicity (Extension)

Patient telecom details.

Required

Language (BackboneElement)

Patient Ethnicity.

Required

maritalStatus (CodeableConcept)

Patient Language.

Required

name (HumanName)

The patient's family (last), Given (First & Middle) name, Prefix or Suffix in a codeable concept or string.

Required

Name Description Required/Optionalription
Id (String) The AllergyIntolerance FHIR ID. Required
active (Boolean) If the patient record is active or inactive. (True & False) Required
address(Address) The address of the patient. Required
birthDate (date) Date (MM-DD-YYYY) of the patient. Required
Communication (BackboneElement) A list of languages used to communicate with the patient, along with an indicator of which is preferred. Required
contact (BackboneElement) Patient Contact details. Required
gender (code) Patient legal Sex. Required
race (Extension) Patient Race. Required
telecom (ContactPoint) Patient telecom details. Required
ethnicity (Extension) Patient telecom details. Required
Language (BackboneElement) Patient Ethnicity. Required
maritalStatus (CodeableConcept) Patient Language. Required
name (HumanName) The patient's family (last), Given (First & Middle) name, Prefix or Suffix in a codeable concept or string. Required


Response Codes:


Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/Patient?_id=85

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Response Code Description Required/Optional
Resource ID (string) The FHIR ID of the patient resource. Required
identifier(string) The chart number of the Patient. Required
name(String) Any Part of the patient name. Required
gender(String) Patient Sex Required
BDate(date) Patient Birth Date Required

Response Code

Description

Required/Optional

Resource ID (string)

The FHIR ID of the patient resource.

Required

identifier(string)

The chart number of the Patient.

Required

name(String)

Any Part of the patient name.

Required

gender(String)

Patient Sex

Required

BDate(date)

Patient Birth Date

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "f1dc250b-88ab-4824-a8d5-fda7b438cf47",

    "meta": {

        "lastUpdated": "2022-11-18T14:48:44.419+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/Patient?_id=85"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "Patient",

                "id": "85",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-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": "text",

                                "valueString": "race"

                            }

                        ]

                    },

                    {

                        "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": "Non - Hispanic/Latino"

                                }

                            },

                            {

                                "url": "text",

                                "valueString": "ethnicity"

                            }

                        ]

                    },

                    {

                        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",

                        "valueCode": "UNK"

                    }

                ],

                "identifier": [

                    {

                        "type": {

                            "coding": [

                                {

                                    "system": "http://terminology.hl7.org/CodeSystem/v2-0203",

                                    "code": "SS"

                                }

                            ]

                        },

                        "system": "http://hl7.org/fhir/sid/us-ssn",

                        "value": "946481516"

                    }

                ],

                "active": true,

                "name": [

                    {

                        "text": "Tejas",

                        "family": "Test5",

                        "given": [

                            "Tejas",

                            "G"

                        ],

                        "suffix": [

                            "Jr"

                        ]

                    },

                    {

                        "text": "Tejas",

                        "family": "Test1",

                        "given": [

                            "Tejas",

                            "G"

                        ],

                        "period": {

                            "start": "2022-11-09T05:00:18+00:00",

                            "end": "2022-11-09T05:26:42+00:00"

                        }

                    },

                    {

                        "text": "Tejas",

                        "family": "Test3",

                        "given": [

                            "Tejas",

                            "G"

                        ],

                        "period": {

                            "start": "2022-11-09T05:26:42+00:00"

                        }

                    }

                ],

                "telecom": [

                    {

                        "system": "phone",

                        "value": "(555)-723-1544",

                        "use": "home"

                    },

                    {

                        "system": "phone",

                        "value": "(555)-777-1234",

                        "use": "mobile"

                    }

                ],

                "gender": "male",

                "birthDate": "2013-07-31",

                "address": [

                    {

                        "line": [

                            "1357, Amber Dr, Beaverton"

                        ],

                        "city": "Beaverton",

                        "state": "OR",

                        "postalCode": "3"

                    },

                    {

                        "line": [

                            "1357, Amber Dr, Beaverton"

                        ],

                        "city": "Beaverton",

                        "state": "OR",

                        "postalCode": "3",

                        "period": {

                            "start": "2022-11-09T05:00:18+00:00"

                        }

                    }

                ],

                "maritalStatus": {

                    "coding": [

                        {

                            "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",

                            "code": "M",

                            "display": "Married"

                        }

                    ]

                },

                "communication": [

                    {

                        "language": {

                            "coding": [

                                {

                                    "system": "urn:ietf:bcp:47",

                                    "code": "eng",

                                    "display": "English"

                                }

                            ]

                        }

                    }

                ]

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

Required


Patient Resource Content:


Name Description Required/Optionalription
Id (String) The Patient resource FHIR ID. Required
active (Boolean) If the patient record is active or inactive. (True & False) Required
address(Address) The address of the patient. Required
birthDate (date) Date (MM-DD-YYYY) of the patient. Required
Communication (BackboneElement) Patient Contact details. Required
contact (BackboneElement) Reaction name Required
gender (code) Patient legal Sex. Required
race (Extension) Patient Race. Required
telecom (ContactPoint) Patient telecom details. Required
ethnicity (Extension) Patient Ethnicity. Required
Language (BackboneElement) Patient Language. Required
maritalStatus (CodeableConcept) Patient Marital Status. Required
name (HumanName) The patient's family (last), Given (First & Middle) name, Prefix or Suffix in a codeable concept or string. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

Id (string)

The Patient resource FHIR ID.

Required

active (Boolean)

If the patient record is active or inactive.

(True & False)

Required

address (Address)

The address of the patient.

Required

birthDate (date)

Date (MM-DD-YYYY) of the patient.

Required

Communication (BackboneElement)


Patient Contact details.

Required

contact (BackboneElement)

Reaction name

Required

gender (code)

Patient legal Sex.

Required

race (Extension)

Patient Race.

Required

telecom (ContactPoint)

Patient telecom details.

Required

ethnicity(Extension)

Patient Ethnicity.

Required

Language(BackboneElement)

Patient Language.

Required

maritalStatus (CodeableConcept)

Patient Marital Status.

Required

name (HumanName)

The patient's family (last), Given (First & Middle) name, Prefix or Suffix in a codeable concept or string.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required


Response Codes:


Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Encounter

Description:


The encounter resource defines the setting where patient care takes place. This includes ambulatory, inpatient, emergency, home health, and virtual encounters.

Encounter is primarily used to record information about the actual activities that occurred , where appointment is used to record planned activities.

Interaction:


 1.   Read

                      1.1.   Request

1.1.1.   URL -  /mps/fhir/R4/Encounter/Encounter-112-385

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Response Code Description Required/Optional
Resource ID (string) Resource ID (string) Required

Response Code

Description

Required/Optional

Resource ID (string)

The FHIR ID of the Encounter Resource.

Required



1.2.   Response


{

    "resourceType": "Encounter",

    "id": "Encounter-112-385",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"

        ]

    },

    "identifier": [

        {

            "system": "https://onchit-fhir.meditab.com/Encounter/Identifier",

            "value": "Encounter-112-385"

        }

    ],

    "status": "finished",

    "class": {

        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",

        "code": "AMB",

        "display": "ambulatory"

    },

    "type": [

        {

            "text": "Office Visit"

        }

    ],

    "subject": {

        "reference": "Patient/85"

    },

    "participant": [

        {

            "type": [

                {

                    "coding": [

                        {

                            "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",

                            "code": "PPRF",

                            "display": "primary performer"

                        }

                    ]

                }

            ],

            "period": {

                "start": "2015-06-22T04:55:00+00:00",

                "end": "2015-07-22T00:00:00+00:00"

            },

            "individual": {

                "reference": "Practitioner/Practitioner-2"

            }

        }

    ],

    "period": {

        "start": "2015-06-22T04:55:00+00:00",

        "end": "2015-06-22T05:25:00+00:00"

    },

    "reasonCode": [

        {

            "text": "Nebulizer Therapy"

        }

    ],

    "hospitalization": {

        "dischargeDisposition": {

            "coding": [

                {

                    "system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",

                    "code": "oth",

                    "display": "Other"

                }

            ]

        }

    },

    "location": [

        {

            "location": {

                "reference": "Location/Location-1"

            }

        }

    ]

}



Name Description Description
Encounter A single encounter resource. Required

Name

Description

Required/Optional

Required


Encounter Resource Content:


Name Description Required/Optional
Id (string) The encounter type. Required
status(code) If the encounter is finished or not. Required
class (Coding) Classification of patient encounters. Required
type Date (MM-DD-YYYY) of the patient. Required
participant (BackboneElement) List of participants involved in the encounter. Required
period (Period) Period of time during the encounter that the participant participated. Required
reasonCode (CodeableConcept) The reason for the visit. Required
hospitalization (BackboneElement) Details about the admission to a healthcare service. Required
location (BackboneElement) Location reference id. Can return a department, location, hospital room, or bed. Department and location are determined dynamically depending on a variety of factors. Required
subject(reference) Reference to the Patient resource who was the subject of the encounter. Required

Name

Description

Required/Optional

Id (string)

The encounter type.

Required

status(code)

If the encounter is finished or not.

Required

class (Coding)

Classification of patient encounters.

Required

type

Date (MM-DD-YYYY) of the patient.

Required

participant (BackboneElement)

List of participants involved in the encounter.

Required

period (Period)

Period of time during the encounter that the participant participated.

Required

reasonCode (CodeableConcept)

The reason for the visit.

Required

hospitalization (BackboneElement)

Details about the admission to a healthcare service.

Required

location (BackboneElement)

Location reference id. Can return a department, location, hospital room, or bed. Department and location are determined dynamically depending on a variety of factors.

Required

subject(reference)

Reference to the Patient resource who was the subject of the encounter.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/Encounter?_id=Encounter-112-385

2.1.2.   HTTP Method : GET

               2.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the Encounter Resource. Required
patient (reference) Reference to a patient resource. Required
date (date) A date range that the encounter takes place. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the Encounter Resource.

Required

patient (reference)

Reference to a patient resource.

Required

date (date)

A date range that the encounter takes place.

Required


2.2.   Response

{

    "resourceType": "Bundle",

    "id": "8364cc12-a082-49f2-917c-25009d3b0567",

    "meta": {

        "lastUpdated": "2022-11-18T14:57:10.722+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/Encounter?_id=Encounter-112-385"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "Encounter",

                "id": "Encounter-112-385",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"

                    ]

                },

                "identifier": [

                    {

                        "system": "https://onchit-fhir.meditab.com/Encounter/Identifier",

                        "value": "Encounter-112-385"

                    }

                ],

                "status": "finished",

                "class": {

                    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",

                    "code": "AMB",

                    "display": "ambulatory"

                },

                "type": [

                    {

                        "text": "Office Visit"

                    }

                ],

                "subject": {

                    "reference": "Patient/85"

                },

                "participant": [

                    {

                        "type": [

                            {

                                "coding": [

                                    {

                                        "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",

                                        "code": "PPRF",

                                        "display": "primary performer"

                                    }

                                ]

                            }

                        ],

                        "period": {

                            "start": "2015-06-22T04:55:00+00:00",

                            "end": "2015-07-22T00:00:00+00:00"

                        },

                        "individual": {

                            "reference": "Practitioner/Practitioner-2"

                        }

                    }

                ],

                "period": {

                    "start": "2015-06-22T04:55:00+00:00",

                    "end": "2015-06-22T05:25:00+00:00"

                },

                "reasonCode": [

                    {

                        "text": "Nebulizer Therapy"

                    }

                ],

                "hospitalization": {

                    "dischargeDisposition": {

                        "coding": [

                            {

                                "system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",

                                "code": "oth",

                                "display": "Other"

                            }

                        ]

                    }

                },

                "location": [

                    {

                        "location": {

                            "reference": "Location/Location-1"

                        }

                    }

                ]

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name Description Required/Optional
Bundle (Bundle) Resource bundle. (For more information, refer to the FHIR specification.) Required
Entry Resource bundle. (For more information, refer to the FHIR specification.) Required
Encounter A single encounter resource. Required

Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

Required


Encounter Resource Content:


Name Description Required/Optional
Id (string) The Patient resource FHIR ID. Required
status(code) If the encounter is finished or not. Required
class (Coding) Classification of patient encounters. Required
type(CodeableConcept) The encounter type. Required
participant (BackboneElement) List of participants involved in the encounter. Required
period (Period) Period of time during the encounter that the participant participated. Required
reasonCode (CodeableConcept) The reason for the visit. Required
hospitalization (BackboneElement) Details about the admission to a healthcare service. Required
location (BackboneElement) Location reference id. Can return a department, location, hospital room, or bed. Department and location are determined dynamically depending on a variety of factors. Required
subject(reference) Reference to the Patient resource who was the subject of the encounter. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

Id (string)

The Patient resource FHIR ID.

Required

status(code)

If the encounter is finished or not.

Required

class (Coding)

Classification of patient encounters.

Required

The encounter type.

Required

participant (BackboneElement)

List of participants involved in the encounter.

Required

period (Period)

Period of time during the encounter that the participant participated.

Required

reasonCode (CodeableConcept)

The reason for the visit.

Required

hospitalization (BackboneElement)

Details about the admission to a healthcare service.

Required

location (BackboneElement)

Location reference id. Can return a department, location, hospital room, or bed. Department and location are determined dynamically depending on a variety of factors.

Required

subject(reference)

Reference to the Patient resource who was the subject of the encounter.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Immunization

Description:


A patient’s immunization history, including information on the vaccine and vaccine administration, is provided via the FHIR Immunization resource.This resource contains the functionality to query a patient’s immunization history.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL -   /mps/fhir/R4/Immunization/Immunization-Patient1

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the immunization resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the immunization resource.

Required



1.2.   Response


{

    "resourceType": "Immunization",

    "id": "Immunization-Patient1",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"

        ]

    },

    "status": "completed",

    "statusReason": {

        "coding": [

            {

                "system": "http://snomed.info/sct"

            }

        ]

    },

    "vaccineCode": {

        "coding": [

            {

                "system": "http://hl7.org/fhir/sid/cvx",

                "code": "106",

                "display": "Tetanus and diptheria toxoids"

            }

        ]

    },

    "patient": {

        "reference": "Patient/3"

    },

    "occurrenceDateTime": "2012-04-01T00:00:00+00:00",

    "primarySource": false,

    "location": {

        "reference": "Organization/Organization-1"

    },

    "site": {

        "coding": [

            {

                "system": "http://terminology.hl7.org/CodeSystem/v3-ActSite"

            }

        ]

    },

    "route": {

        "coding": [

            {

                "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration"

            }

        ]

    },

    "doseQuantity": {

        "value": 0.000

    }

}



Name Description Required/Optional
Immunization A single Immunization resource. Required

Name

Description

Required/Optional


Encounter Resource Content:


Name Description Required/Optional
status(code) The status of the immunizations: Completed not-done Required
Id (string) The Immunization FHIR ID. Required
statusReason (CodeableConcept) Why immunization did not occur. Required
vaccineCode (CodeableConcept) Vaccine product administered. Required
patient(reference) Reference to a patient who was immunized. Required
occurrenceDateTime (dateTime) Vaccination administration date and time Required
primarySource (Boolean) The reason for the visit. Required
location (Reference) Location where vaccination occurred. Required
site (CodeableConcept) Body site where the vaccine was administered. Required
route (CodeableConcept) How the vaccine entered the body. Required
doseQuantity(Quantity) Information about the amount of vaccine administered. Required

Name

Description

Required/Optional

status(code)

The status of the immunizations:

  • Completed
  • not-done

Required

Id (string)

The Immunization FHIR ID.

Required

statusReason (CodeableConcept)

Why immunization did not occur.

Required

vaccineCode (CodeableConcept)

Vaccine product administered.

Required

patient(reference)

Reference to a patient who was immunized.

Required

occurrenceDateTime (dateTime)

Vaccination administration date and time

Required

primarySource (Boolean)


The reason for the visit.

Required

location (Reference)

Location where vaccination occurred.

Required

Body site where the vaccine was administered.

Required

How the vaccine entered the body.

Required

doseQuantity(Quantity)

Information about the amount of vaccine administered.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

               2.1.1.   URL -  /mps/fhir/R4/Immunization?_id=Immunization-Patient7

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the immunization resource.

Required

Patient ID(reference)

The reference ID of the Patient resource.

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "1804183c-db19-45e6-9573-60131172701b",

    "meta": {

        "lastUpdated": "2022-11-21T06:21:22.772+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/Immunization?_id=Immunization-Patient7"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "Immunization",

                "id": "Immunization-Patient7",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"

                    ]

                },

                "status": "completed",

                "statusReason": {

                    "coding": [

                        {

                            "system": "http://snomed.info/sct"

                        }

                    ]

                },

                "vaccineCode": {

                    "coding": [

                        {

                            "system": "http://hl7.org/fhir/sid/cvx",

                            "code": "106",

                            "display": "Tetanus and diptheria toxoids"

                        }

                    ]

                },

                "patient": {

                    "reference": "Patient/85"

                },

                "occurrenceDateTime": "2012-01-04T00:00:00+00:00",

                "primarySource": false,

                "location": {

                    "reference": "Organization/Organization-1"

                },

                "site": {

                    "coding": [

                        {

                            "system": "http://terminology.hl7.org/CodeSystem/v3-ActSite"

                        }

                    ]

                },

                "route": {

                    "coding": [

                        {

                            "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration"

                        }

                    ]

                },

                "doseQuantity": {

                    "value": 0.000

                }

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required


Immunization Resource Content:


Name Description Required/Optional
status(code) The status of the immunizations: Completed not-done Required
Id (string) The Immunization FHIR ID. Required
statusReason (CodeableConcept) Why immunization did not occur. Required
vaccineCode (CodeableConcept) Vaccine product administered. Required
patient(Reference) Whether the immunization data is historical and therefore reported by a patient or another system. Required
occurrenceDateTime (DateTime) Vaccination administration date and time Required
primarySource (Boolean) The reason for the visit. Required
location (Reference) Location where vaccination occurred. Required
site (CodeableConcept)ity (Quantity) Body site where the vaccine was administered. Required
route (CodeableConcept) How the vaccine entered the body. Required
doseQuantity (Quantity) Information about the amount of vaccine administered. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

status(code)

The status of the immunizations:

  • Completed
  • not-done

Required

Id (string)

The Immunization FHIR ID.

Required

statusReason (CodeableConcept)

Why immunization did not occur.

Required

vaccineCode (CodeableConcept)

Vaccine product administered.

Required

patient(Reference)

Whether the immunization data is historical and therefore reported by a patient or another system.

Required

occurrenceDateTime (DateTime)

Vaccination administration date and time

Required

primarySource (Boolean)

The reason for the visit.

Required

location (Reference)

Location where vaccination occurred.

Required

Body site where the vaccine was administered.

Required

How the vaccine entered the body.

Required

doseQuantity (Quantity)

Information about the amount of vaccine administered.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Goal

Description:


The goal resource lists the goals that are intended for a patient. A goal is often defined as a desirable result or health state that a patient is to accomplish over time or at a particular moment in time.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL -  /mps/fhir/R4/Goal/Goal-4

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the Goal resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the Goal resource.

Required



1.2.   Response

{

    "resourceType": "Goal",

    "id": "Goal-4",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"

        ]

    },

    "lifecycleStatus": "active",

    "achievementStatus": {

        "text": "not achieved"

    },

    "description": {

        "text": "a. Get rid of intermittent fever that is occurring every few weeks.\r\nb. Need to gain more energy to do regular activities."

    },

    "subject": {

        "reference": "Patient/85"

    },

    "startDate": "2022-09-26",

    "target": [

        {

            "measure": {

                "text": "61146-7"

            },

            "dueDate": "2022-12-30"

        }

    ]

}



Name Description Required/Optional
Goal A single goal resource. Required

Name

Description

Required/Optional

Required


Goal Resource Content:


Name Description Required/Optional
lifecycleStatus (code) lifecycleStatus (code) Required
Id (string) The Goal FHIR ID. Required
description (CodeableConcept) What the goal entails. SNOMED code or other text describing the goal. Required
achievementStatus (CodeableConcept) Goal is achieved or not. Required
subject (Reference) The FHIR Patient ID. Required
startDate (date) When goal pursuit begins. Required
target(BackboneElement) What should be done by when. Required

Name

Description

Required/Optional

lifecycleStatus (code)

A goal’s status is either active or completed for care paths.

Required

Id (string)

The Goal FHIR ID.

Required

description (CodeableConcept)

What the goal entails. SNOMED code or other text describing the goal.

Required

achievementStatus (CodeableConcept)

Goal is achieved or not.

Required

subject (Reference)

The FHIR Patient ID.

Required

startDate (date)

When goal pursuit begins.

Required

What should be done by when.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/Goal?_id=Goal-4

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the Goal resource.

Required

Patient ID(reference)

The reference ID of the Patient resource.

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "555d63a3-53e5-4023-895b-1436c05c0b98",

    "meta": {

        "lastUpdated": "2022-11-21T06:35:35.794+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/Goal?_id=Goal-4"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "Goal",

                "id": "Goal-4",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"

                    ]

                },

                "lifecycleStatus": "active",

                "achievementStatus": {

                    "text": "not achieved"

                },

                "description": {

                    "text": "a. Get rid of intermittent fever that is occurring every few weeks.\r\nb. Need to gain more energy to do regular activities."

                },

                "subject": {

                    "reference": "Patient/85"

                },

                "startDate": "2022-09-26",

                "target": [

                    {

                        "measure": {

                            "text": "61146-7"

                        },

                        "dueDate": "2022-12-30"

                    }

                ]

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

Required


Goal Resource Content:


Name Description Required/Optional
lifecycleStatus (code) A goal’s status is either active or completed for care paths. Required
Id (string) The Goal FHIR ID. Required
description (CodeableConcept) What the goal entails. SNOMED code or other text describing the goal. Required
achievementStatus (CodeableConcept) Goal is achieved or not. Required
subject (Reference) The FHIR Patient ID Required
startDate (date) When goal pursuit begins. Required
target(BackboneElement) What should be done by when. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

lifecycleStatus (code)

A goal’s status is either active or completed for care paths.

Required

Id (string)

The Goal FHIR ID.

Required

description (CodeableConcept)

What the goal entails. SNOMED code or other text describing the goal.

Required

achievementStatus (CodeableConcept)

Goal is achieved or not.

Required

subject (Reference)

The FHIR Patient ID

Required

startDate (date)

When goal pursuit begins.

Required

What should be done by when.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Condition

Description:


The condition resource is used to record problems, diagnosis , or other health issues affecting a patient. Depending on the site, problems and diagnostics are used differently.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL -  /mps/fhir/R4/Condition/Condition-83

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) Resource ID (string) Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the condition resource.

Required



1.2.   Response


{

    "resourceType": "Condition",

    "id": "Condition-2",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"

        ]

    },

    "clinicalStatus": {

        "coding": [

            {

                "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",

                "code": "active",

                "display": "Health Concern"

            }

        ]

    },

    "verificationStatus": {

        "coding": [

            {

                "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",

                "code": "confirmed",

                "display": "Confirmed"

            }

        ]

    },

    "category": [

        {

            "coding": [

                {

                    "system": "http://hl7.org/fhir/us/core/CodeSystem/condition-category",

                    "code": "health-concern",

                    "display": "Health Concern"

                }

            ]

        }

    ],

    "code": {

        "coding": [

            {

                "system": "http://snomed.info/sct",

                "code": "386661006",

                "display": "Fever (finding)"

            }

        ]

    },

    "subject": {

        "reference": "Patient/85"

    },

    "encounter": {

        "reference": "Encounter/Encounter--"

    }

}



Name Description Required/Optional
Condition An instance of the R4 Condition resource. Required

Name

Description

Required/Optional

An instance of the R4 Condition resource.

Required


Condition Resource Content:


Name Description Required/Optional
clinicalStatus (CodeableConcept) The current status of the condition. Possible values include: active, resolved, inactive. Required
Id (string) The condition FHIR ID. Required
verificationStatus (CodeableConcept) If the condition is on the patient's chart, this element specifies "confirmed". Required
category (CodeableConcept) Health-concern , Problem-list-item or encounter-diagnosis Required
code (CodeableConcept) Snomed-ct codes of the condition. Required
subject (Reference) The patient associated with the condition. Required
encounter(Reference) The encounter associated with the condition. Required

Name

Description

Required/Optional

clinicalStatus (CodeableConcept)

The current status of the condition. Possible values include:

  • active
  • resolved
  • inactive

Required

Id (string)

The condition FHIR ID.

Required

verificationStatus (CodeableConcept)

If the condition is on the patient's chart, this element specifies "confirmed".

Required

category (CodeableConcept)

Health-concern , Problem-list-item or encounter-diagnosis

Required

Snomed-ct codes of the condition.

Required

subject (Reference)

The patient associated with the condition.

Required

encounter(Reference)

The encounter associated with the condition.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/Condition?_id=Condition-Problem-83

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the condition resource.

Required

Patient ID(reference)

The reference ID of the Patient resource.

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "613f2f13-2bad-42d1-ac07-ac65b3c3fb3e",

    "meta": {

        "lastUpdated": "2022-11-21T06:49:51.679+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/Condition?_id=Condition-Problem-83"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "Condition",

                "id": "Condition-Problem-83",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"

                    ]

                },

                "clinicalStatus": {

                    "coding": [

                        {

                            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",

                            "code": "resolved",

                            "display": "Resolved"

                        }

                    ]

                },

                "verificationStatus": {

                    "coding": [

                        {

                            "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",

                            "code": "confirmed",

                            "display": "Confirmed"

                        }

                    ]

                },

                "category": [

                    {

                        "coding": [

                            {

                                "system": "http://hl7.org/fhir/us/core/CodeSystem/condition-category",

                                "code": "problem-list-item",

                                "display": "Problem List Item"

                            }

                        ]

                    }

                ],

                "code": {

                    "coding": [

                        {

                            "system": "http://snomed.info/sct",

                            "code": "238131007",

                            "display": "Overweight (finding)"

                        }

                    ]

                },

                "subject": {

                    "reference": "Patient/85"

                },

                "encounter": {

                    "reference": "Encounter/Encounter-112"

                },

                "onsetDateTime": "2006-12-31T05:32:53+00:00"

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

Required


Condition  Resource Content:


Name Description Required/Optional
clinicalStatus (CodeableConcept) The current status of the condition. Possible values include: active, resolved, inactive. Required
Id (string) The condition FHIR ID. Required
verificationStatus (CodeableConcept) health-concern Required
category (CodeableConcept) Goal is achieved or not. Required
code (CodeableConcept) Snomed-ct codes of the condition. Required
subject (Reference) The patient associated with the condition. Required
encounter(Reference) The encounter associated with the condition. Required
onsetDateTime(DateTime) The date the problem was resolved. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

clinicalStatus (CodeableConcept)

The current status of the condition. Possible values include:

  • active
  • resolved
  • inactive

Required

Id (string)

The condition FHIR ID.

Required

verificationStatus (CodeableConcept)

health-concern

Required

category (CodeableConcept)

Goal is achieved or not.

Required

Snomed-ct codes of the condition.

Required

subject (Reference)

The patient associated with the condition.

Required

encounter(Reference)

The encounter associated with the condition.

Required

onsetDateTime(DateTime)

The date the problem was resolved.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Organization

Description:


The organizational resource describes a grouping of people or business units relevant to the healthcare process. Organizations include hospitals, employers, insurance companies, medical practices, rehabilitation facilities, laboratories etc.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL -  /mps/fhir/R4/Condition/Condition-83

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) Resource ID (string) Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the Organization resource.

Required



1.2.   Response


{

    "resourceType": "Organization",

    "id": "Organization-1",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"

        ]

    },

    "identifier": [

        {

            "system": "http://hl7.org/fhir/sid/us-npi",

            "value": "9971816761"

        }

    ],

    "active": true,

    "name": "Neighborhood Physicians Practice",

    "telecom": [

        {

            "system": "phone",

            "value": "(525)-555-1002"

        },

        {

            "system": "email"

        },

        {

            "system": "fax",

            "value": "123-123-1231"

        }

    ],

    "address": [

        {

            "line": [

                "2472, Rocky place, Beaverton, OR-97006"

            ],

            "city": "Beaverton",

            "state": "OR",

            "postalCode": "3",

            "country": "USA"

        }

    ]

}



Name Description Required/Optional
Organization A single instance of organization resource. Required

Name

Description

Required/Optional

A single instance of organization resource.

Required


Organization Resource Content:


Name Description Required/Optional
active (Boolean) Organization is active or not. Required
Id (string) The condition FHIR ID. Required
identifier (Identifier) Organization unique Identifier. Required
name (string) The name used for the organization. Required
telecom (ContactPoint) The phone number, fax number, email and emergency phone number. Required
type (CodeableConcept) This element supports the following extensible bindings:organizationType: The organization type. departmentSpecialty: The department specialty Required
address (Address) The Organization address. Required

Name

Description

Required/Optional

active (Boolean)

Organization is active or not.

Required

Id (string

The condition FHIR ID.

Required

identifier (Identifier)

Organization unique Identifier.

Required

name (string)

The name used for the organization.

Required

telecom (ContactPoint)

The phone number, fax number, email and emergency phone number.

Required

This element supports the following extensible bindings:

  • organizationType: The organization type.
  • departmentSpecialty: The department specialty

Required

address (Address)

The Organization address.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/Organization?_id=Organization-1

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the Organization resource. Required
name(string) Organization name Required
address(string) Organization address Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the Organization resource.

Required

name(string)

Organization name

Required

address(string)

Organization address

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "19fdc00a-e79e-45fb-b3ca-a17aabd15d67",

    "meta": {

        "lastUpdated": "2022-11-21T07:06:44.509+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/Organization?_id=Organization-1"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "Organization",

                "id": "Organization-1",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"

                    ]

                },

                "identifier": [

                    {

                        "system": "http://hl7.org/fhir/sid/us-npi",

                        "value": "9971816761"

                    }

                ],

                "active": true,

                "name": "Neighborhood Physicians Practice",

                "telecom": [

                    {

                        "system": "phone",

                        "value": "(525)-555-1002"

                    },

                    {

                        "system": "email"

                    },

                    {

                        "system": "fax",

                        "value": "123-123-1231"

                    }

                ],

                "address": [

                    {

                        "line": [

                            "2472, Rocky place, Beaverton, OR-97006"

                        ],

                        "city": "Beaverton",

                        "state": "OR",

                        "postalCode": "3",

                        "country": "USA"

                    }

                ]

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

A single instance of organization resource.

Required


Organization  Resource Content:


Name Description Required/Optional
active (Boolean) Organization is active or not. Required
Id (string) The Organization FHIR ID. Required
identifier (Identifier) Organization unique Identifier. Required
name (string) The name used for the organization. Required
telecom (ContactPoint) The phone number, fax number, email and emergency phone number. Required
type (CodeableConcept) This element supports the following extensible bindings: organizationType: The organization type. departmentSpecialty: The department specialty Required
address (Address) The Organization address. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

active (Boolean)

Organization is active or not.

Required

Id (string)

The Organization FHIR ID.

Required

identifier (Identifier)

Organization unique Identifier.

Required

name (string)

The name used for the organization.

Required

telecom (ContactPoint)

The phone number, fax number, email and emergency phone number.

Required

This element supports the following extensible bindings:

  • organizationType: The organization type.
  • departmentSpecialty: The department specialty

Required

address (Address)

The Organization address.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Medication Request

Description:


The MedicationRequest resource provides orders for all the medications along with administration instructions for a patient in both inpatient and outpatient settings(orders/prescriptions filled by a pharmacy and discharge medication orders). This resource also includes a patient’s historical or documented home medications as reported by the patient, their spouse or another provider.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL -  /mps/fhir/R4/MedicationRequest/MedicationRequest-254

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the MedicationRequest resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the MedicationRequest resource.

Required



1.2.   Response


{

    "resourceType": "MedicationRequest",

    "id": "MedicationRequest-254",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"

        ]

    },

    "status": "active",

    "intent": "order",

    "reportedBoolean": false,

    "medicationCodeableConcept": {

        "coding": [

            {

                "system": "http://www.nlm.nih.gov/research/umls/rxnorm",

                "code": "RX00000082",

                "display": "CELEXA 20 MG TABLET"

            }

        ]

    },

    "subject": {

        "reference": "Patient/85"

    },

    "encounter": {

        "reference": "Encounter/Encounter-112-387"

    },

    "authoredOn": "2020-09-10T00:57:55+00:00",

    "requester": {

        "reference": "Practitioner/Practitioner-6"

    },

    "dosageInstruction": [

        {

            "text": "1 every evening"

        }

    ],

    "dispenseRequest": {

        "numberOfRepeatsAllowed": 2,

        "quantity": {

            "value": 30.000000,

            "unit": "Tablet",

            "system": "http://unitsofmeasure.org",

            "code": "C48542"

        },

        "expectedSupplyDuration": {

            "value": 30,

            "unit": "days",

            "system": "http://unitsofmeasure.org",

            "code": "d"

        }

    },

    "substitution": {

        "allowedBoolean": true

    }

}



Name Description Required/Optional
MedicationRequest A single instance of MedicationRequest resource. A single instance of MedicationRequest resource.

Name

Description

Required/Optional

A single instance of MedicationRequest resource.

Required


MedicationRequest Resource Content:


Name Description Required/Optional
status (code) The status of the medication request. Required
Id (string) The MedicationRequest FHIR ID. Required
intent (code) Returns “plan” for patient-reported and historical medications. Returns “order” for other medications. Required
reportedBoolean (Boolean) True or False (If Prescription By is set to self or Sample then False) Required
Medication (CodeableConcept) Rx norm code of the drug and drug description. Required
subject(Reference) Patient resource id. Required
encounter(Reference) Encounter resource id. Required
authoredOn (string) The date the prescription was written. Required
requester(Reference) Resource id of the practitioner Who made the request? Required
dosageInstruction (Dosage) Dosage instruction details. Required
dispenseRequest ( BackboneElement) Medication supply authorization. Required
substitution (BackboneElement) Whether substitution is allowed or not. optional

Name

Description

Required/Optional

status (code)

The status of the medication request.

Required

Id (string)

The MedicationRequest FHIR ID.

Required

intent (code)

Returns “plan” for patient-reported and historical medications. Returns “order” for other medications.

Required

reportedBoolean (Boolean)

True or False (If Prescription By is set to self or Sample then False)

Required

Medication (CodeableConcept)

Rx norm code of the drug and drug description.

Required

subject(Reference)

Patient resource id.

Required

encounter(Reference)

Encounter resource id.

Required

authoredOn (string)

The date the prescription was written.

Required

requester(Reference)

Resource id of the practitioner Who made the request?

Required

dosageInstruction (Dosage)

Dosage instruction details.

Required

dispenseRequest ( BackboneElement)

Medication supply authorization.

Required

substitution (BackboneElement)

Whether substitution is allowed or not.

optional

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/MedicationRequest?_id=MedicationRequest-254

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) Resource ID (string) Required
Patient ID(reference) The reference ID of the Patient resource. Required
status(code) MedicationRequest status Required
intent(code) MedicationRequest Intent Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the MedicationRequest resource.

Required

Patient ID(reference)

The reference ID of the Patient resource.

Required

status(code)

MedicationRequest status

Required

intent(code)

MedicationRequest Intent

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "839e3fb5-380d-44ed-a293-dee8b6e19b57",

    "meta": {

        "lastUpdated": "2022-11-21T07:32:44.204+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/MedicationRequest?_id=MedicationRequest-254"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "MedicationRequest",

                "id": "MedicationRequest-254",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"

                    ]

                },

                "status": "active",

                "intent": "order",

                "reportedBoolean": false,

                "medicationCodeableConcept": {

                    "coding": [

                        {

                            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",

                            "code": "RX00000082",

                            "display": "CELEXA 20 MG TABLET"

                        }

                    ]

                },

                "subject": {

                    "reference": "Patient/85"

                },

                "encounter": {

                    "reference": "Encounter/Encounter-112-387"

                },

                "authoredOn": "2020-09-10T00:57:55+00:00",

                "requester": {

                    "reference": "Practitioner/Practitioner-6"

                },

                "dosageInstruction": [

                    {

                        "text": "1 every evening"

                    }

                ],

                "dispenseRequest": {

                    "numberOfRepeatsAllowed": 2,

                    "quantity": {

                        "value": 30.000000,

                        "unit": "Tablet",

                        "system": "http://unitsofmeasure.org",

                        "code": "C48542"

                    },

                    "expectedSupplyDuration": {

                        "value": 30,

                        "unit": "days",

                        "system": "http://unitsofmeasure.org",

                        "code": "d"

                    }

                },

                "substitution": {

                    "allowedBoolean": true

                }

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name Description Required/Optional
Bundle (Bundle) Resource bundle. (For more information, refer to the FHIR specification.) Required
Entry A container for a single FHIR resource. Required
MedicationRequest A single instance of MedicationRequest resource. Required

Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

A single instance of MedicationRequest resource.

Required


MedicationRequest  Resource Content:


Name Description Required/Optional
status (code) The status of the medication request. Required
Id (string) The MedicationRequest FHIR ID. Required
intent (code) Returns “plan” for patient-reported and historical medications. Returns “order” for other medications. Required
reportedBoolean (Boolean) True or False (If Prescription By is set to self or Sample then False) Required
Medication (CodeableConcept) Rx norm code of the drug and drug description. Required
subject(Reference) Patient resource id. Required
encounter(Reference) Encounter resource id. Required
authoredOn (DateTime) The date the prescription was written. Required
requester(Reference) Resource id of the practitioner Who made the request? Required
dosageInstruction (Dosage) Medication supply authorization. Required
substitution (BackboneElement) Whether substitution is allowed or not. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

status (code)

The status of the medication request.

Required

Id (string)

The MedicationRequest FHIR ID.

Required

intent (code)

Returns “plan” for patient-reported and historical medications. Returns “order” for other medications.

Required

reportedBoolean (Boolean)

True or False (If Prescription By is set to self or Sample then False)

Required

Medication (CodeableConcept)

Rx norm code of the drug and drug description.

Required

subject(Reference)

Patient resource id.

Required

encounter(Reference)

Encounter resource id.

Required

authoredOn (DateTime)

The date the prescription was written.

Required

requester(Reference)

Resource id of the practitioner Who made the request?

Required

dosageInstruction (Dosage)

Medication supply authorization.

Required

substitution (BackboneElement)

Whether substitution is allowed or not.

optional

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Provenance

Description:


The provenance resource returns contextual metadata about the origin of another resource, such as who created or submitted data about the target resource. Commonly , provenance data is requested as part of the search interaction for a different resource , as described in the FHIR Search Parameters documentation.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL -  /mps/fhir/R4/MedicationRequest/MedicationRequest-254

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the Provenance resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the Provenance resource.

Required



1.2.   Response


{

    "resourceType": "Provenance",

    "id": "Provenance-1",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"

        ]

    },

    "target": [

        {

            "reference": "Patient/1"

        }

    ],

    "recorded": "2007-09-29T00:00:00.000+00:00",

    "agent": [

        {

            "type": {

                "coding": [

                    {

                        "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",

                        "code": "author",

                        "display": "author"

                    }

                ]

            },

            "who": {

                "reference": "Practitioner/Practitioner-2"

            },

            "onBehalfOf": {

                "reference": "Organization/Organization-1"

            }

        },

        {

            "type": {

                "coding": [

                    {

                        "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",

                        "code": "transmitter",

                        "display": "transmitter"

                    }

                ]

            },

            "who": {

                "reference": "Practitioner/Practitioner-2"

            },

            "onBehalfOf": {

                "reference": "Organization/Organization-1"

            }

        }

    ]

}



Name Description Required/Optional
Provenance A single instance of Provenance resource. Required

Name

Description

Required/Optional

A single instance of Provenance resource.

Required


Provenance Resource Content:


Name Description Required/Optional
agent(CodeableConcept) Actors involved, such as the author and transmitter. Who the actor is representing,. How the actor participated., Who participated. Required
Id (string) The Provenance FHIR ID. Required
recorded (instant) Timestamp that the activity was recorded or updated. Required
target(Reference) The resource that this provenance describes. Required

Name

Description

Required/Optional

Actors involved, such as the author and transmitter.

  • Who the actor is representing.
  • How the actor participated.
  • Who participated.

Required

Id (string)

The Provenance FHIR ID.

Required

recorded (instant)

Timestamp that the activity was recorded or updated.

Required

target(Reference)

The resource that this provenance describes.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Procedure

Description:


The procedure resources return medical and surgical procedures performed on or for a patient during their lifetime. Historical procedures as well as procedures recorded during a specific visit are returned. Surgical procedures from finalized closed surgical cases are returned as free text procedures if the solution has been configured to write closed case procedures to the procedure history.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL -  /mps/fhir/R4/Procedure/Procedure-5-99215

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the Procedure resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the Procedure resource.

Required



1.2.   Response


{

    "resourceType": "Procedure",

    "id": "Procedure-5-99215",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"

        ]

    },

    "status": "completed",

    "code": {

        "coding": [

            {

                "system": "http://www.ama-assn.org/go/cpt",

                "code": "99215"

            }

        ]

    },

    "subject": {

        "reference": "Patient/Patient--1"

    },

    "encounter": {

        "reference": "Encounter/Encounter--1"

    },

    "performedDateTime": "2008-05-06T00:00:00+00:00"

}



Name Description Required/Optional
Procedure A single instance of procedure resource. Required

Name

Description

Required/Optional

A single instance of procedure resource.

Required


Procedure Resource Content:


Name Description Required/Optional
status(code) The status of the Procedure. Required
Id (string) The MedicationRequest FHIR ID. Required
code(CodeableConcept) Codes associated with the procedure. Required
subject(Reference) Reference id to a patient resource. Required
encounter(Reference) RequireReference id to the encounter resource.d Required
performedDateTime (DateTime) When the procedure was performed. Required

Name

Description

Required/Optional

status(code

The status of the Procedure.

Required

Id (string)

The MedicationRequest FHIR ID.

Required

Codes associated with the procedure.

Required

subject(Reference)

Reference id to a patient resource.

Required

encounter(Reference)

Reference id to the encounter resource.

Required

performedDateTime (DateTime)

When the procedure was performed.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 1.   Search

1.1.   Request

1.1.1.   URL -  /mps/fhir/R4/Procedure?_id=Procedure-5-99215

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the MedicationRequest resource. Required
Patient ID(reference) The reference ID of the Patient resource. Required
date(date) Date or period that the procedure was performed. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the MedicationRequest resource.

Required

Patient ID(reference)

The reference ID of the Patient resource.

Required

date(date)

Date or period that the procedure was performed.

Required


1.2.   Response


{

    "resourceType": "Bundle",

    "id": "908006e3-8582-4713-aded-47947dc570d0",

    "meta": {

        "lastUpdated": "2022-11-21T07:51:14.260+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/Procedure?_id=Procedure-5-99215"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "Procedure",

                "id": "Procedure-5-99215",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"

                    ]

                },

                "status": "completed",

                "code": {

                    "coding": [

                        {

                            "system": "http://www.ama-assn.org/go/cpt",

                            "code": "99215"

                        }

                    ]

                },

                "subject": {

                    "reference": "Patient/Patient--1"

                },

                "encounter": {

                    "reference": "Encounter/Encounter--1"

                },

                "performedDateTime": "2008-05-06T00:00:00+00:00"

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

A single instance of procedure resource.

Required


Procedure  Resource Content:


Name Description Required/Optional
status (code) The status of the Procedure. Required
Id (string) The MedicationRequest FHIR ID. Required
code(CodeableConcept) Codes associated with the procedure. Required
subject(Reference) Reference id to a patient resource. Required
encounter(Reference) Rx norm code of the drug and drug description. Required
subject(Reference) Patient resource id. Required
encounter(Reference) Reference id to the encounter resource. Required
performedDateTime (DateTime) When the procedure was performed. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

status (code)

The status of the Procedure.

Required

Id (string)

The MedicationRequest FHIR ID.

Required

Codes associated with the procedure.

Required

subject(Reference)

Reference id to a patient resource.

Required

encounter(Reference)

Rx norm code of the drug and drug description.

Required

subject(Reference)

Patient resource id.

Required

encounter(Reference)

Reference id to the encounter resource.

Required

performedDateTime (DateTime)

When the procedure was performed.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Device

Description:


The FHIR device resource describes information on durable , manufactured medical items.Read interactions begin when a client has previously established a relationship, typically when following a reference to that resource from another resource or by querying for devices through the search interaction.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL -  /fhir/R4/Device/Device-4

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) Resource ID (string) Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the device resource.

Required



1.2.   Response


{

    "resourceType": "Device",

    "id": "Device-4",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"

        ]

    },

    "udiCarrier": [

        {

            "deviceIdentifier": "00643169007222",

            "carrierHRF": "(01)00643169007222(17)160128(21)BLC200461H"

        }

    ],

    "distinctIdentifier": "NA",

    "manufacturer": "MEDTRONIC, INC.",

    "manufactureDate": "2011-01-28T00:00:00+00:00",

    "expirationDate": "2016-01-28T00:00:00+00:00",

    "lotNumber": "LT6594",

    "serialNumber": "BLC200461H",

    "modelNumber": "DTBA1QQ",

    "type": {

        "coding": [

            {

                "system": "http://snomed.info/sct",

                "code": "code",

                "display": "Cardiac resynchronization therapy implantable defibrillator"

            }

        ],

        "text": "Cardiac resynchronization therapy implantable defibrillator"

    },

    "patient": {

        "reference": "Patient/85"

    }

}


Name Description Required/Optional
Device A single instance of device resource Required

Name

Description

Required/Optional

A single instance of device resource

Required


Device Resource Content:


Name Description Required/Optional
udiCarrier (BackboneElement) The unique device identification (UDI) is a unique numeric or alphanumeric code related to a medical device. It allows for a clear and unambiguous identification of specific devices on the market and facilitates their traceability. The UDI comprises the following components a device identifier (UDI-DI) a production identifier (UDI-PI) These provide access to useful information about the device. The specificity of the UDI makes traceability of devices more efficient allows easier recall of devices combats counterfeiting improves patient safety The UDI will be an addition to, not a substitute for, the existing labeling requirements for medical devices. Required
Id (string) The MedicationRequest FHIR ID. Required
distinctIdentifier (string) Distinct identification code. Required
manufacturer (string) Device manufacturer. Required
manufactureDate (dateTime) Date of device manufacture. Required
expirationDate (dateTime) Device expiration date. Required
lotNumber (string) Device lot number. Required
serialNumber (string) Device serial number. Required
modelNumber (string) Device model number. Required
type(CodeableConcept) A SNOMED or other device code. Required
patient(Reference) Patient identifier. Required

Name

Description

Required/Optional

udiCarrier (BackboneElement)

The unique device identification (UDI) is a unique numeric or alphanumeric code related to a medical device. It allows for a clear and unambiguous identification of specific devices on the market and facilitates their traceability. The UDI comprises the following components

  • a device identifier (UDI-DI)
  • a production identifier (UDI-PI)

These provide access to useful information about the device. The specificity of the UDI

  • makes traceability of devices more efficient
  • allows easier recall of devices
  • combats counterfeiting
  • improves patient safety

The UDI will be an addition to, not a substitute for, the existing labeling requirements for medical devices.

Required

Id (string)

The MedicationRequest FHIR ID.

Required

distinctIdentifier (string)

Distinct identification code.

Required

manufacturer (string)

Device manufacturer.

Required

manufactureDate (dateTime)

Date of device manufacture.

Required

expirationDate (dateTime)

Device expiration date.

Required

lotNumber (string)

Device lot number.

Required

serialNumber (string)

Device serial number.

Required

modelNumber (string)

Device model number.

Required

A SNOMED or other device code.

Required

patient(Reference)

Patient identifier.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/Device?_id=Device-4

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) Patient ID(reference) Required
Patient ID(reference) The reference ID of the Patient resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the device resource.

Required

Patient ID(reference)

The reference ID of the Patient resource.

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "d39170ac-18a2-43c1-b554-9fa0a242a556",

    "meta": {

        "lastUpdated": "2022-11-21T07:59:17.827+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/Device?_id=Device-4"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "Device",

                "id": "Device-4",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"

                    ]

                },

                "udiCarrier": [

                    {

                        "deviceIdentifier": "00643169007222",

                        "carrierHRF": "(01)00643169007222(17)160128(21)BLC200461H"

                    }

                ],

                "distinctIdentifier": "NA",

                "manufacturer": "MEDTRONIC, INC.",

                "manufactureDate": "2011-01-28T00:00:00+00:00",

                "expirationDate": "2016-01-28T00:00:00+00:00",

                "lotNumber": "LT6594",

                "serialNumber": "BLC200461H",

                "modelNumber": "DTBA1QQ",

                "type": {

                    "coding": [

                        {

                            "system": "http://snomed.info/sct",

                            "code": "code",

                            "display": "Cardiac resynchronization therapy implantable defibrillator"

                        }

                    ],

                    "text": "Cardiac resynchronization therapy implantable defibrillator"

                },

                "patient": {

                    "reference": "Patient/85"

                }

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

A single instance of device resource.

Required


MedicationRequest  Resource Content:


Name Description Required/Optional
udiCarrier (BackboneElement) The unique device identification (UDI) is a unique numeric or alphanumeric code related to a medical device. It allows for a clear and unambiguous identification of specific devices on the market and facilitates their traceability. The UDI comprises the following components a device identifier (UDI-DI) a production identifier (UDI-PI) These provide access to useful information about the device. The specificity of the UDI makes traceability of devices more efficient allows easier recall of devices combats counterfeiting improves patient safety The UDI will be an addition to, not a substitute for, the existing labeling requirements for medical devices. Required
Id (string) The MedicationRequest FHIR ID. Required
distinctIdentifier (string) Distinct identification code. Required
manufacturer (string) Device manufacturer. Required
manufactureDate (dateTime) Date of device manufacture. Required
expirationDate (dateTime) Device expiration date. Required
lotNumber (string) Device lot number. Required
serialNumber (string) Device serial number. Required
modelNumber (string) Device model number. Required
type(CodeableConcept) A SNOMED or other device code. Required
patient(Reference) Patient identifier. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

udiCarrier (BackboneElement)

The unique device identification (UDI) is a unique numeric or alphanumeric code related to a medical device. It allows for a clear and unambiguous identification of specific devices on the market and facilitates their traceability. The UDI comprises the following components

  • a device identifier (UDI-DI)
  • a production identifier (UDI-PI)

These provide access to useful information about the device. The specificity of the UDI

  • makes traceability of devices more efficient
  • allows easier recall of devices
  • combats counterfeiting
  • improves patient safety

The UDI will be an addition to, not a substitute for, the existing labeling requirements for medical devices.

Required

Id (string)

The MedicationRequest FHIR ID.

Required

distinctIdentifier (string)

Distinct identification code.

Required

manufacturer (string)

Device manufacturer.

Required

manufactureDate (dateTime)

Date of device manufacture.

Required

expirationDate (dateTime)

Device expiration date.

Required

lotNumber (string)

Device lot number.

Required

serialNumber (string)

Device serial number.

Required

modelNumber (string)

Device model number.

Required

A SNOMED or other device code.

Required

patient(Reference)

Patient identifier.

optional

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Practitioner

Description:


The practitioner resource provides information about an individual formally involved in the care of a patient on behalf of a healthcare facility. Practitioners include physicians, nurses, pharmacists, therapists, technologists, and social workers , among others.The read interaction allows you to store only the ID and get the most up-to-date role information on a practitioner with a single request. Read interactions typically begin with a client having previously established a relationship.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL - /mps/fhir/R4/Practitioner/Practitioner-2

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the practitioner resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the practitioner resource.

Required



1.2.   Response


{

    "resourceType": "Practitioner",

    "id": "Practitioner-2",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"

        ]

    },

    "identifier": [

        {

            "system": "http://hl7.org/fhir/sid/us-npi",

            "value": "9036838370"

        }

    ],

    "active": true,

    "name": [

        {

            "family": "Davis",

            "given": [

                "Albert",

                "H"

            ],

            "suffix": [

                "Dr"

            ]

        }

    ],

    "telecom": [

        {

            "system": "phone"

        },

        {

            "system": "email",

            "value": "tejasp@meditab.com"

        }

    ],

    "gender": "male"

}



Name Description Required/Optional
Practitioner A single Practitioner resource. Required

Name

Description

Required/Optional


Practitioner Resource Content:


Name Description Required/Optional
identifier (Identifier) The practitioner or user ID. Required
Id (string) The practitioner FHIR ID. Required
active (Boolean) Whether the practitioner's record is in active use. Required
name (HumanName) The name of the practitioner, including all prefixes and suffixes available. Required
telecom (ContactPoint) Practitioner phone & email address Required
Gender (code) Practitioner Sex Required

Name

Description

Required/Optional

identifier (Identifier)

The practitioner or user ID.

Required

Id (string)

The practitioner FHIR ID.

Required

active (Boolean)

Whether the practitioner's record is in active use.

Required

name (HumanName)

The name of the practitioner, including all prefixes and suffixes available.

Required

telecom (ContactPoint)

Practitioner phone & email address

Required

Gender (code)

Practitioner Sex

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/Practitioner?_id=Practitioner-2

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the practitioner resource. Required
identifier(string) The NPI of the practitioner. Required
name(string) Name of the practitioner. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the practitioner resource.

Required

identifier(string)

The NPI of the practitioner.

Required

name(string)

Name of the practitioner.

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "c8dae86d-d54a-4d43-8509-433e5e7e2d03",

    "meta": {

        "lastUpdated": "2022-11-21T08:11:15.998+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/Practitioner?_id=Practitioner-2"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "Practitioner",

                "id": "Practitioner-2",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"

                    ]

                },

                "identifier": [

                    {

                        "system": "http://hl7.org/fhir/sid/us-npi",

                        "value": "9036838370"

                    }

                ],

                "active": true,

                "name": [

                    {

                        "family": "Davis",

                        "given": [

                            "Albert",

                            "H"

                        ],

                        "suffix": [

                            "Dr"

                        ]

                    }

                ],

                "telecom": [

                    {

                        "system": "phone"

                    },

                    {

                        "system": "email",

                        "value": "tejasp@meditab.com"

                    }

                ],

                "gender": "male"

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name Description Required/Optional
Bundle (Bundle) Resource bundle. (For more information, refer to the FHIR specification.) Required
Entry A container for a single FHIR resource. Required
Practitioner A single instance of Practitioner resource. Required

Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

A single instance of Practitioner resource.

Required


Practitioner  Resource Content:


Name Description Required/Optional
identifier (Identifier) The practitioner or user ID. Required
Id (string) The practitioner FHIR ID. Required
active (Boolean) Whether the practitioner's record is in active use. Required
name (HumanName) The name of the practitioner, including all prefixes and suffixes available. Required
telecom (ContactPoint) Practitioner phone & email address Required
gender (code) Practitioner Sex Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

identifier (Identifier)

The practitioner or user ID.

Required

Id (string)

The practitioner FHIR ID.

Required

active (Boolean)

Whether the practitioner's record is in active use.

Required

name (HumanName)

The name of the practitioner, including all prefixes and suffixes available.

Required

telecom (ContactPoint)

Practitioner phone & email address

Required

gender (code)

Practitioner Sex

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

CarePlan

Description:


The care plan resource describes the intentions of how one or more physicians plan to deliver a particular patient. Care plans are used in a variety of areas and applications ranging from encounters or specific visits to mutual visits. Care Plans are used to group activities, goals and practitioners to provide context. Care plans should be patient specific. It is possible that a planned activity without a care plan, such as a scheduled appointment, stands alone.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL - /mps/fhir/R4/CarePlan/CarePlan-385-18776-5

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the CarePlan resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the CarePlan resource.

Required



1.2.   Response


{

    "resourceType": "CarePlan",

    "id": "CarePlan-385-18776-5",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"

        ]

    },

    "text": {

        "status": "additional",

        "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">i. Get An EKG done on 06/23/2015.\r\nii. Get a Chest X-ray done on 06/23/2015 showing the Lower Respiratory Tract Sturucture.\r\niii. Take Clindamycin 300mg Three times a day as needed if pain does not subside.\r\niv. Schedule follow on visit with Neighborhood Physicians Practice on 07/01/2015.\r\n</div>"

    },

    "status": "active",

    "intent": "order",

    "category": [

        {

            "coding": [

                {

                    "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",

                    "code": "assess-plan"

                }

            ]

        }

    ],

    "subject": {

        "reference": "Patient/85"

    },

    "encounter": {

        "reference": "Encounter/Encounter-112-385"

    }

}




Name Description Required/Optional
CarePlan A single instance of CarePlan resource. Required

Name

Description

Required/Optional

A single instance of CarePlan resource.

Required


CarePlan Resource Content:


Name Description Required/Optional
text (Narrative) The note(s) associated with this encounter-level CarePlanThe practitioner or user ID. Required
Id (string) The CarePlan FHIR ID. Required
status (code) active Required
intent (code) order Required
category (CodeableConcept) In addition, category type "assess-plan" is always included in search results. Required
subject(Reference) Reference to a patient resource for whom the care plan is relevant. Required
Encounter(Reference) Reference to a patient resource for whom the care plan is relevant. Required

Name

Description

Required/Optional

text (Narrative)

The note(s) associated with this encounter-level CarePlanThe practitioner or user ID.

Required

Id (string)

The CarePlan FHIR ID.

Required

status (code)

active

Required

intent (code)

order

Required

category (CodeableConcept)

In addition, category type "assess-plan" is always included in search results.

Required

subject(Reference)

Reference to a patient resource for whom the care plan is relevant.

Required

encounter(Reference

The encounter or episode of care associated with this CarePlan.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/CarePlan?_id=CarePlan-385-18776-5

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the CarePlan resource.

Required

Patient ID(reference)

The reference ID of the Patient resource.

Required

category(CodeableConcept)

Asses-plan

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "1f432d74-2e14-4dfc-8ee6-1fd73602c28c",

    "meta": {

        "lastUpdated": "2022-11-21T08:34:06.948+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/CarePlan?_id=CarePlan-385-18776-5"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "CarePlan",

                "id": "CarePlan-385-18776-5",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"

                    ]

                },

                "text": {

                    "status": "additional",

                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">i. Get An EKG done on 06/23/2015.\r\nii. Get a Chest X-ray done on 06/23/2015 showing the Lower Respiratory Tract Sturucture.\r\niii. Take Clindamycin 300mg Three times a day as needed if pain does not subside.\r\niv. Schedule follow on visit with Neighborhood Physicians Practice on 07/01/2015.\r\n</div>"

                },

                "status": "active",

                "intent": "order",

                "category": [

                    {

                        "coding": [

                            {

                                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",

                                "code": "assess-plan"

                            }

                        ]

                    }

                ],

                "subject": {

                    "reference": "Patient/85"

                },

                "encounter": {

                    "reference": "Encounter/Encounter-112-385"

                }

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

A single instance of CarePlan resource.

Required


CarePlan Resource Content:


Name Description Required/Optional
text (Narrative) The note(s) associated with this encounter-level CarePlan Required
Id (string) The CarePlan FHIR ID. Required
intent (code) order Required
category (CodeableConcept) In addition, category type "assess-plan" is always included in search results. Required
subject(Reference) Reference to a patient resource for whom the care plan is relevant. Required
encounter(Reference) The encounter or episode of care associated with this CarePlan. Required
entry An array of entries included in this bundle. Required
total (Int64) An array of entries included in this bundle. Required

Name

Description

Required/Optional

text (Narrative)

The note(s) associated with this encounter-level CarePlan

Required

Id (string)

The CarePlan FHIR ID.

Required

intent (code)

order

Required

category (CodeableConcept)

In addition, category type "assess-plan" is always included in search results.

Required

subject(Reference)

Reference to a patient resource for whom the care plan is relevant.

Required

encounter(Reference)

The encounter or episode of care associated with this CarePlan.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Care Team

Description:


The care team resource represents a patient’s care team members. The members or participants of the care team include practitioners(doctors, nurses, technicians, etc). Family members, friends, guardians and the patient. The care team can be specific to an encounter or to the patient across all encounters.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL - /mps/fhir/R4/CareTeam/CareTeam-2

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the CareTeam resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the CareTeam resource.

Required



1.2.   Response


{

    "resourceType": "CareTeam",

    "id": "CareTeam-2",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"

        ]

    },

    "status": "active",

    "name": "Test 1",

    "subject": {

        "reference": "Patient/85"

    },

    "encounter": {

        "reference": "Encounter/Encounter-112-385"

    },

    "participant": [

        {

            "role": [

                {

                    "text": "Provider"

                }

            ],

            "member": {

                "reference": "Practitioner/Practitioner-2"

            }

        },

        {

            "role": [

                {

                    "text": "Provider"

                }

            ],

            "member": {

                "reference": "Practitioner/Practitioner-107"

            }

        }

    ]

}



Name Description Required/Optional
CareTeam A single instance of CareTeam instance. Required

Name

Description

Required/Optional

A single instance of CareTeam instance.

Required


CareTeam Resource Content:


Name Description Required/Optional
status (code) The status of the episode for which the care team is defined. Required
Id (string) The Care Team FHIR ID. Required
name (string) The name of the care team. Required
participant (BackboneElement) A participant in the care team. Required
subject(Reference) Reference to a patient resource for whom the CareTeam is relevant. Required
encounter(Reference) Reference to an encounter resource for whom the CareTeam is relevant. Required

Name

Description

Required/Optional

status (code)

The status of the episode for which the care team is defined.

Required

Id (string)

The Care Team FHIR ID.

Required

name (string)

The name of the care team.

Required

participant (BackboneElement)

A participant in the care team.

Required

subject(Reference)

Reference to a patient resource for whom the CareTeam is relevant.

Required

encounter(Reference)

Reference to an encounter resource  for whom the CareTeam is relevant.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/CareTeam?_id=CareTeam-2

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the CareTeam resource. Required
Patient ID(reference) The reference ID of the Patient resource. Required
status(code) Status of the episode. (Active or Inactive) Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the CareTeam resource.

Required

Patient ID(reference)

The reference ID of the Patient resource.

Required

status(code)

Status of the episode. (Active or Inactive)

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "c75b050e-fda6-4573-a773-241eb19653fc",

    "meta": {

        "lastUpdated": "2022-11-21T08:48:55.403+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/CareTeam?_id=CareTeam-2"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "CareTeam",

                "id": "CareTeam-2",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"

                    ]

                },

                "status": "active",

                "name": "Test 1",

                "subject": {

                    "reference": "Patient/85"

                },

                "encounter": {

                    "reference": "Encounter/Encounter-112-385"

                },

                "participant": [

                    {

                        "role": [

                            {

                                "text": "Provider"

                            }

                        ],

                        "member": {

                            "reference": "Practitioner/Practitioner-2"

                        }

                    },

                    {

                        "role": [

                            {

                                "text": "Provider"

                            }

                        ],

                        "member": {

                            "reference": "Practitioner/Practitioner-107"

                        }

                    }

                ]

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

A single instance of Care Team resource.

Required


CarePlan Resource Content:


Name Description Required/Optional
status (code) The status of the episode for which the care team is defined. Required
Id (string) The Care Team FHIR ID. Required
name (string)) The name of the care team. Required
participant (BackboneElement) A participant in the care team. Required
subject(Reference) Reference to a patient resource for whom the care plan is relevant. Required
subject(Reference) Reference to a patient resource for whom the CareTeam is relevant. Required
encounter(Reference) Reference to an encounter resource for whom the CareTeam is relevant. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

status (code)

The status of the episode for which the care team is defined.

Required

Id (string)

The Care Team FHIR ID.

Required

name (string))

The name of the care team.

Required

participant (BackboneElement)

A participant in the care team.

Required

subject(Reference)

Reference to a patient resource for whom the care plan is relevant.

Required

subject(Reference)

Reference to a patient resource for whom the CareTeam is relevant.

Required

encounter(Reference)

Reference to an encounter resource  for whom the CareTeam is relevant.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Observation

Description:


Vital signs, laboratory results, imaging results, device measurements, clinical evaluation tools, personal traits, social history, and core features are all defined in the FHIR Observation resource. One of the first areas where a single, universal vocabulary is required to enable universal access and re-use is in the field of vital signs. Particularly when patients are using wearables and need or want to exchange information from those devices.

Interaction:


 1.   Read

1.1.   Request

1.1.1.   URL - /mps/fhir/R4/Observation/Observation-vital-Body-Temperature-385-2-C-85

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the observation resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the observation resource.

Required



1.2.   Response


{

    "resourceType": "Observation",

    "id": "Observation-vital-Body-Temperature-385-2-C-85",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/StructureDefinition/bodytemp"

        ]

    },

    "status": "final",

    "category": [

        {

            "coding": [

                {

                    "system": "http://terminology.hl7.org/CodeSystem/observation-category",

                    "code": "vital-signs",

                    "display": "Vital Signs"

                }

            ]

        }

    ],

    "code": {

        "coding": [

            {

                "system": "http://loinc.org",

                "code": "8310-5",

                "display": "Body Temperature"

            }

        ]

    },

    "subject": {

        "reference": "Patient/85"

    },

    "effectiveDateTime": "2022-09-26T00:00:00+00:00",

    "valueQuantity": {

        "value": 100.40,

        "unit": "degF",

        "system": "http://unitsofmeasure.org",

        "code": "[degF]"

    }

}



Name Description Required/Optional
Observation A single instance of Observation resource. Required

Name

Description

Required/Optional

A single instance of Observation resource.

Required


Observation Resource Content:


Name Description Required/Optional
status (code) The status of the observation. Required
Id (string) The Observation FHIR ID Required
category (CodeableConcept) This element always returns "vital-signs". Required
code(CodeableConcept) Loinc Code Required
subject(Reference) Reference to a patient resource for whom the observation is relevant. Required
effectiveDateTime (dateTime) The date and time the observation was taken. Required
valueQuantity(Quantity) This element is populated if a value has units or the data type is numeric or a percentile. Only one of the value* elements is required. Required

Name

Description

Required/Optional

status (code)

The status of the observation.

Required

Id (string)

The Observation FHIR ID

Required

category (CodeableConcept)

This element always returns "vital-signs".

Required

Loinc Code

Required

subject(Reference)

Reference to a patient resource for whom the observation is relevant.

Required

effectiveDateTime (dateTime)

The date and time the observation was taken.

Required

valueQuantity(Quantity)

This element is populated if a value has units or the data type is numeric or a percentile. Only one of the value* elements is required.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /fhir/R4/Observation?_id=Observation-vital-Body-Temperature-385-2-C-85

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the observation resource. Required
Patient ID(reference) The reference ID of the Patient resource. Required
code(CodeableConcept) Loinc code for different types of observations. Required
category(CodeableConcept) Different types of observation. Required
date(date) The date range for when the observation was taken. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the observation resource.

Required

Patient ID(reference)

The reference ID of the Patient resource.

Required

Loinc code for different types of observations.

Required

category(CodeableConcept)

Different types of observation.

Required

date(date)

The date range for when the observation was taken.

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "8ae4f1fc-3c65-4c06-b8f3-df66645dbc7b",

    "meta": {

        "lastUpdated": "2022-11-21T08:56:20.428+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/Observation?_id=Observation-vital-Body-Temperature-385-2-C-85"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "Observation",

                "id": "Observation-vital-Body-Temperature-385-2-C-85",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/StructureDefinition/bodytemp"

                    ]

                },

                "status": "final",

                "category": [

                    {

                        "coding": [

                            {

                                "system": "http://terminology.hl7.org/CodeSystem/observation-category",

                                "code": "vital-signs",

                                "display": "Vital Signs"

                            }

                        ]

                    }

                ],

                "code": {

                    "coding": [

                        {

                            "system": "http://loinc.org",

                            "code": "8310-5",

                            "display": "Body Temperature"

                        }

                    ]

                },

                "subject": {

                    "reference": "Patient/85"

                },

                "effectiveDateTime": "2022-09-26T00:00:00+00:00",

                "valueQuantity": {

                    "value": 100.40,

                    "unit": "degF",

                    "system": "http://unitsofmeasure.org",

                    "code": "[degF]"

                }

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}




Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

A single instance of Observation resource.

Required


CarePlan Resource Content:


Name Description Required/Optional
status (code) The status of the observation. Required
Id (string) The Observation FHIR ID. Required
category (CodeableConcept) Types of observation. Required
code(CodeableConcept) Loinc Code Required
subject(Reference) Reference to a patient resource for whom the observation is relevant. Required
effectiveDateTime (dateTime) The date and time the observation was taken. Required
valueQuantity(Quantity) This element is populated if a value has units or the data type is numeric or a percentile. Only one of the value* elements are required. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

status (code)

The status of the observation.

Required

Id (string)

The Observation FHIR ID.

Required

category (CodeableConcept)

Types of observation.

Required

Loinc Code

Required

subject(Reference)

Reference to a patient resource for whom the observation is relevant.

Required

effectiveDateTime (dateTime)

The date and time the observation was taken.

Required

valueQuantity(Quantity)

This element is populated if a value has units or the data type is numeric or a percentile. Only one of the value* elements are required.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)

Diagnostic Report

Description:


A diagnostic report is the set of information that is typically provided by a diagnostic service when investigations are complete. The information includes a mix of atomic results, text reports, images, and codes. The mix varies depending on the nature of the diagnostic procedure, and sometimes on the nature of the outcomes for a particular investigation.

Interaction


 1.   Read

1.1.   Request

1.1.1.   URL - /mps/fhir/R4/DiagnosticReport/DiagnosticReport-L-448-173

1.1.2.   HTTP Method : GET

1.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the DiagnosticReport resource. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the DiagnosticReport resource.

Required



1.2.   Response


{

    "resourceType": "DiagnosticReport",

    "id": "DiagnosticReport-L-448-173",

    "meta": {

        "profile": [

            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"

        ]

    },

    "status": "final",

    "category": [

        {

            "coding": [

                {

                    "system": "http://terminology.hl7.org/CodeSystem/v2-0074",

                    "code": "LAB",

                    "display": "laboratory"

                }

            ]

        }

    ],

    "code": {

        "coding": [

            {

                "system": "http://loinc.org",

                "code": "24357-6",

                "display": "URINALYSIS,MACROSCOPIC"

            }

        ]

    },

    "subject": {

        "reference": "Patient/85"

    },

    "encounter": {

        "reference": "Encounter/Encounter-112-385"

    },

    "effectiveDateTime": "2022-09-26T00:00:00+00:00",

    "issued": "2022-09-26T06:21:55.400+00:00",

    "performer": [

        {

            "reference": "Organization/Organization-1"

        }

    ],

    "result": [

        {

            "reference": "Observation/Observation-lab-448-173-385"

        },

        {

            "reference": "Observation/Observation-lab-448-173-388"

        },

        {

            "reference": "Observation/Observation-lab-448-173-389"

        },

        {

            "reference": "Observation/Observation-lab-448-173-390"

        },

        {

            "reference": "Observation/Observation-lab-448-173-393"

        },

        {

            "reference": "Observation/Observation-lab-448-173-394"

        },

        {

            "reference": "Observation/Observation-lab-448-173-396"

        }

    ],

    "presentedForm": [

        {

            "contentType": "text/plain",

            "data": "Q2pFNU5URXRNRGt0TURRS0NpTWdRMmhwWldZZ1EyOXRjR3hoYVc1MENrNXZJR052YlhCc1lXbHVkSE11Q2dvaklFaHBjM1J2Y25rZ2IyWWdVSEpsYzJWdWRDQkpiR3h1WlhOekNreDFZMmxsYmpRd09DQnBjeUJoSURFeElIbGxZWEl0YjJ4a0lHNXZiaTFvYVhOd1lXNXBZeUIzYUdsMFpTQnRZV3hsTGlCUVlYUnBaVzUwSUdoaGN5QmhJR2hwYzNSdmNua2diMllnYjNScGRHbHpJRzFsWkdsaExDQmhZM1YwWlNCMmFYSmhiQ0J3YUdGeWVXNW5hWFJwY3lBb1pHbHpiM0prWlhJcExDQm1jbUZqZEhWeVpTQnZaaUJqYkdGMmFXTnNaUzRLQ2lNZ1UyOWphV0ZzSUVocGMzUnZjbmtLSUZCaGRHbGxiblFnYUdGeklHNWxkbVZ5SUhOdGIydGxaQ0JoYm1RZ2FYTWdZVzRnWVd4amIyaHZiR2xqTGdvS1VHRjBhV1Z1ZENCamIyMWxjeUJtY205dElHRWdhR2xuYUNCemIyTnBiMlZqYjI1dmJXbGpJR0poWTJ0bmNtOTFibVF1SUZCaGRHbGxiblFnWTNWeWNtVnVkR3g1SUdoaGN5QkNiSFZsSUVOeWIzTnpJRUpzZFdVZ1UyaHBaV3hrTGdvS0l5QkJiR3hsY21kcFpYTUtUbThnUzI1dmQyNGdRV3hzWlhKbmFXVnpMZ29LSXlCTlpXUnBZMkYwYVc5dWN3cHdaVzVwWTJsc2JHbHVJR2NnTXpjMUlHMW5MMjFzSUdsdWFtVmpkR0ZpYkdVZ2MyOXNkWFJwYjI0N0lHRnpjR2x5YVc0Z09ERWdiV2NnYjNKaGJDQjBZV0pzWlhRS0NpTWdRWE56WlhOemJXVnVkQ0JoYm1RZ1VHeGhiZ3BRWVhScFpXNTBJR2x6SUhCeVpYTmxiblJwYm1jZ2QybDBhQ0IyYVhKaGJDQnphVzUxYzJsMGFYTWdLR1JwYzI5eVpHVnlLUzRnQ2dvakl5QlFiR0Z1Q2dwVWFHVWdabTlzYkc5M2FXNW5JSEJ5YjJObFpIVnlaWE1nZDJWeVpTQmpiMjVrZFdOMFpXUTZDaTBnYldWa2FXTmhkR2x2YmlCeVpXTnZibU5wYkdsaGRHbHZiaUFvY0hKdlkyVmtkWEpsS1FwVWFHVWdjR0YwYVdWdWRDQjNZWE1nY0hKbGMyTnlhV0psWkNCMGFHVWdabTlzYkc5M2FXNW5JRzFsWkdsallYUnBiMjV6T2dvdElHRnRiM2hwWTJsc2JHbHVJREkxTUNCdFp5QXZJR05zWVhaMWJHRnVZWFJsSURFeU5TQnRaeUJ2Y21Gc0lIUmhZbXhsZEFv"

        }

    ]

}



Name Description Required/Optional
DiagnosticReport A single instance of DiagnosticReport resource. Required

Name

Description

Required/Optional

A single instance of DiagnosticReport resource.

Required


DiagnosticReport Resource Content:


Name Description Required/Optional
Required/Optional The status of the report. Required
Id (string) The DiagnosticReport FHIR ID. Required
category (CodeableConcept) The service category. This can be LAB, Imaging or any other category type supported by IMS. Required
code(CodeableConcept) Code of diagnostic report. Required
subject(Reference) Reference to a patient resource for whom the diagnostic report is relevant. Required
encounter(Reference) Reference to an encounter resource for whom the diagnostic report is relevant. Required
issued (instant) Date time when the report was available. Required
performer (Reference) Organization resource id. Required
result (Reference) Observation resource id. Required
presentedForm (Attachment) An attachment in the form of embedded format (base64) or URL. Required

Name

Description

Required/Optional

status (code)

The status of the report.

Required

Id (string)

The DiagnosticReport FHIR ID.

Required

category (CodeableConcept)

The service category. This can be LAB, Imaging or any other category type supported by IMS.

Required

Code of diagnostic report.

Required

subject(Reference)

Reference to a patient resource for whom the diagnostic report is relevant.

Required

encounter(Reference)

Reference to an encounter resource for whom the diagnostic report is relevant.

Required

issued (instant)

Date time when the report was available.

Required

performer (Reference)

Organization resource id.

Required

result (Reference)

Observation resource id.

Required

presentedForm (Attachment)

An attachment in the form of embedded format (base64) or URL.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error



 2.   Search

2.1.   Request

2.1.1.   URL -  /mps/fhir/R4/DiagnosticReport?_id=DiagnosticReport-L-448-173

2.1.2.   HTTP Method : GET

2.1.3.   Parameter


Name Description Required/Optional
Resource ID (string) The FHIR ID of the DiagnosticReport resource. Required
Patient ID(reference) The reference ID of the Patient resource. Required
category(CodeableConcept) Different types of diagnostic reports. Required
code(CodeableConcept) Code for Different types of diagnostic report. Required
date(date) The date range for when the observation was taken. Required

Name

Description

Required/Optional

Resource ID (string)

The FHIR ID of the DiagnosticReport resource.

Required

Patient ID(reference)

The reference ID of the Patient resource.

Required

category(CodeableConcept)

Different types of diagnostic reports.

Required

Code for Different types of diagnostic report.

Required

date(date)

The date range for when the observation was taken.

Required


2.2.   Response


{

    "resourceType": "Bundle",

    "id": "74479011-d133-4b85-b588-b4016d7d9a04",

    "meta": {

        "lastUpdated": "2022-11-21T09:02:18.646+00:00"

    },

    "type": "searchset",

    "total": 1,

    "link": [

        {

            "relation": "self",

            "url": "https://172.26.60.114:2525/mps/fhir/R4/DiagnosticReport?_id=DiagnosticReport-L-448-173"

        }

    ],

    "entry": [

        {

            "resource": {

                "resourceType": "DiagnosticReport",

                "id": "DiagnosticReport-L-448-173",

                "meta": {

                    "profile": [

                        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"

                    ]

                },

                "status": "final",

                "category": [

                    {

                        "coding": [

                            {

                                "system": "http://terminology.hl7.org/CodeSystem/v2-0074",

                                "code": "LAB",

                                "display": "laboratory"

                            }

                        ]

                    }

                ],

                "code": {

                    "coding": [

                        {

                            "system": "http://loinc.org",

                            "code": "24357-6",

                            "display": "URINALYSIS,MACROSCOPIC"

                        }

                    ]

                },

                "subject": {

                    "reference": "Patient/85"

                },

                "encounter": {

                    "reference": "Encounter/Encounter-112-385"

                },

                "effectiveDateTime": "2022-09-26T00:00:00+00:00",

                "issued": "2022-09-26T06:21:55.400+00:00",

                "performer": [

                    {

                        "reference": "Organization/Organization-1"

                    }

                ],

                "result": [

                    {

                        "reference": "Observation/Observation-lab-448-173-385"

                    },

                    {

                        "reference": "Observation/Observation-lab-448-173-388"

                    },

                    {

                        "reference": "Observation/Observation-lab-448-173-389"

                    },

                    {

                        "reference": "Observation/Observation-lab-448-173-390"

                    },

                    {

                        "reference": "Observation/Observation-lab-448-173-393"

                    },

                    {

                        "reference": "Observation/Observation-lab-448-173-394"

                    },

                    {

                        "reference": "Observation/Observation-lab-448-173-396"

                    }

                ],

                "presentedForm": [

                    {

                        "contentType": "text/plain",

                        "data": "Q2pFNU5URXRNRGt0TURRS0NpTWdRMmhwWldZZ1EyOXRjR3hoYVc1MENrNXZJR052YlhCc1lXbHVkSE11Q2dvaklFaHBjM1J2Y25rZ2IyWWdVSEpsYzJWdWRDQkpiR3h1WlhOekNreDFZMmxsYmpRd09DQnBjeUJoSURFeElIbGxZWEl0YjJ4a0lHNXZiaTFvYVhOd1lXNXBZeUIzYUdsMFpTQnRZV3hsTGlCUVlYUnBaVzUwSUdoaGN5QmhJR2hwYzNSdmNua2diMllnYjNScGRHbHpJRzFsWkdsaExDQmhZM1YwWlNCMmFYSmhiQ0J3YUdGeWVXNW5hWFJwY3lBb1pHbHpiM0prWlhJcExDQm1jbUZqZEhWeVpTQnZaaUJqYkdGMmFXTnNaUzRLQ2lNZ1UyOWphV0ZzSUVocGMzUnZjbmtLSUZCaGRHbGxiblFnYUdGeklHNWxkbVZ5SUhOdGIydGxaQ0JoYm1RZ2FYTWdZVzRnWVd4amIyaHZiR2xqTGdvS1VHRjBhV1Z1ZENCamIyMWxjeUJtY205dElHRWdhR2xuYUNCemIyTnBiMlZqYjI1dmJXbGpJR0poWTJ0bmNtOTFibVF1SUZCaGRHbGxiblFnWTNWeWNtVnVkR3g1SUdoaGN5QkNiSFZsSUVOeWIzTnpJRUpzZFdVZ1UyaHBaV3hrTGdvS0l5QkJiR3hsY21kcFpYTUtUbThnUzI1dmQyNGdRV3hzWlhKbmFXVnpMZ29LSXlCTlpXUnBZMkYwYVc5dWN3cHdaVzVwWTJsc2JHbHVJR2NnTXpjMUlHMW5MMjFzSUdsdWFtVmpkR0ZpYkdVZ2MyOXNkWFJwYjI0N0lHRnpjR2x5YVc0Z09ERWdiV2NnYjNKaGJDQjBZV0pzWlhRS0NpTWdRWE56WlhOemJXVnVkQ0JoYm1RZ1VHeGhiZ3BRWVhScFpXNTBJR2x6SUhCeVpYTmxiblJwYm1jZ2QybDBhQ0IyYVhKaGJDQnphVzUxYzJsMGFYTWdLR1JwYzI5eVpHVnlLUzRnQ2dvakl5QlFiR0Z1Q2dwVWFHVWdabTlzYkc5M2FXNW5JSEJ5YjJObFpIVnlaWE1nZDJWeVpTQmpiMjVrZFdOMFpXUTZDaTBnYldWa2FXTmhkR2x2YmlCeVpXTnZibU5wYkdsaGRHbHZiaUFvY0hKdlkyVmtkWEpsS1FwVWFHVWdjR0YwYVdWdWRDQjNZWE1nY0hKbGMyTnlhV0psWkNCMGFHVWdabTlzYkc5M2FXNW5JRzFsWkdsallYUnBiMjV6T2dvdElHRnRiM2hwWTJsc2JHbHVJREkxTUNCdFp5QXZJR05zWVhaMWJHRnVZWFJsSURFeU5TQnRaeUJ2Y21Gc0lIUmhZbXhsZEFv"

                    }

                ]

            },

            "search": {

                "mode": "match"

            }

        }

    ]

}



Name

Description

Required/Optional

Bundle (Bundle)

Resource bundle. (For more information, refer to the FHIR specification.)

Required

Entry

A container for a single FHIR resource.

Required

A single instance of DiagnosticReport resource.

Required


DiagnosticReport Resource Content:


Name Description Required/Optional
status (code) The status of the report. Required
Id (string) The DiagnosticReport FHIR ID. Required
category (CodeableConcept) The service category. This can be LAB, Imaging or any other category type supported by IMS. Required
code(CodeableConcept) Code of diagnostic report. Required
subject(Reference) Reference to a patient resource for whom the diagnostic report is relevant. Required
encounter(Reference) Reference to an encounter resource for whom the diagnostic report is relevant. Required
issued (instant) Date time when the report was available. Required
performer (Reference) Organization resource id. Required
result (Reference) Observation resource id. Required
presentedForm (Attachment) An attachment in the form of embedded format (base64) or URL. Required
entry An array of entries included in this bundle. Required
total (Int64) Total number of resources that matched the search criteria. Required

Name

Description

Required/Optional

status (code)

The status of the report.

Required

Id (string)

The DiagnosticReport FHIR ID.

Required

category (CodeableConcept)

The service category. This can be LAB, Imaging or any other category type supported by IMS.

Required

Code of diagnostic report.

Required

subject(Reference)

Reference to a patient resource for whom the diagnostic report is relevant.

Required

encounter(Reference)

Reference to an encounter resource for whom the diagnostic report is relevant.

Required

issued (instant)

Date time when the report was available.

Required

performer (Reference)

Organization resource id.

Required

result (Reference)

Observation resource id.

Required

presentedForm (Attachment)

An attachment in the form of embedded format (base64) or URL.

Required

entry

An array of entries included in this bundle.

Required

total (Int64)

Total number of resources that matched the search criteria.

Required

Response Code

Description

200 OK

The requested resource was found and is contained within the body of the HTTP response.

400 Bad Request

The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.

404 Not Found

The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

410 Gone

The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.

500 Internal Server Error

The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

5xx Server Error

The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error

Product Information                         

IMS (14.0.SP1)