Encounters

To define

Supported Formats

json
>>>

GET /Encounter
Encounters

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Examples

GET /Encounter?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "b9279d97234794aead278f6b883020a3",
  "type": "search set",
  "entry": [
    {
      "full_url": "/Encounter/1009",
      "resource": {
        "resourceType": "Encounter",
        "id": "1009",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
          ]
        },
        "identifier": [
          {
            "type": {
              "coding": [
                {
                  "code": "MR",
                  "display": "Medical record number"
                }
              ],
              "text": "Medical record number"
            },
            "system": null,
            "value": "{\"patient_name\"=>{\"first_name\"=>\"Alice\", \"preferred_name\"=>\"Alice\", \"middle_name\"=>\"Jones\", \"suffix\"=>nil, \"last_name\"=>\"Newman\", \"birth_name\"=>\"Alicia\", \"previous_first_name\"=>\"Alicia\", \"previous_middle_name\"=>\"Jones\", \"previous_last_name\"=>\"Newman\"}, \"identifier\"=>1009, \"name\"=>\"Clinician Progress Note\", \"code\"=>\"90837\", \"code_system\"=>\"2.16.840.1.113883.6.12\", \"code_system_name\"=>\"CPT\", \"admit_date\"=>\"20210801\", \"discharge_date\"=>\"20210801\", \"location\"=>\"\", \"encounter_diagnosis\"=>{}, \"performer\"=>{\"first_name\"=>\"Albert\", \"last_name\"=>\"Davis\", \"display_name\"=>\"Albert Davis\", \"address_line_1\"=>\"2472, Rocky place\", \"city\"=>\"Beaverton\", \"state\"=>\"FL\", \"postal_code\"=>\"97006\", \"tel\"=>nil}, \"consult_note\"=>\"\", \"history_and_physical_note\"=>\"\", \"reason_for_referral\"=>\"\", \"progress_note\"=>\"\", \"author\"=>{\"current_time\"=>\"2021-08-01\"}}"
          }
        ],
        "status": "finished",
        "class": {
          "code": "AMB",
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "display": "ambulatory"
        },
        "type": [
          {
            "coding": [
              {
                "code": "",
                "system": "http://www.ama-assn.org/go/cpt"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/1",
          "display": "Alice, Newman"
        },
        "participant": [
          {
            "type": [
              {
                "coding": [
                  {
                    "code": "PPRF",
                    "display": "primary performer"
                  }
                ],
                "text": "Primary Performer"
              }
            ],
            "period": {
              "start": "2021-08-01T00:00:00+00:00",
              "end": "2021-08-01T00:00:00+00:00"
            },
            "individual": {
              "reference": "Practitioner/",
              "display": null
            }
          }
        ],
        "period": {
          "start": "2021-08-01T00:00:00+00:00",
          "end": "2021-08-01T00:00:00+00:00"
        },
        "reasonCode": [
          {
            "coding": [
              {
                "system": "http://www.ama-assn.org/go/cpt",
                "code": ""
              }
            ]
          }
        ],
        "hospitalization": {
          "dischargeDisposition": {
            "coding": [
              {
                "system": "http://www.ama-assn.org/go/cpt",
                "code": ""
              }
            ]
          }
        },
        "location": [
          {
            "location": {
              "reference": "Organization/"
            }
          }
        ],
        "serviceProvider": {
          "reference": "Organization/",
          "type": "Organization"
        }
      }
    },
    {
      "full_url": "/Encounter/1001",
      "resource": {
        "resourceType": "Encounter",
        "id": "1001",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
          ]
        },
        "identifier": [
          {
            "type": {
              "coding": [
                {
                  "code": "MR",
                  "display": "Medical record number"
                }
              ],
              "text": "Medical record number"
            },
            "system": null,
            "value": "{\"patient_name\"=>{\"first_name\"=>\"Alice\", \"preferred_name\"=>\"Alice\", \"middle_name\"=>\"Jones\", \"suffix\"=>nil, \"last_name\"=>\"Newman\", \"birth_name\"=>\"Alicia\", \"previous_first_name\"=>\"Alicia\", \"previous_middle_name\"=>\"Jones\", \"previous_last_name\"=>\"Newman\"}, \"identifier\"=>1001, \"name\"=>\"Fever (finding)\", \"code\"=>\"386661006\", \"code_system\"=>\"2.16.840.1.113883.6.96\", \"code_system_name\"=>\"SNOMEDCT\", \"admit_date\"=>\"2015-06-22T00:00:00.000-04:00\", \"discharge_date\"=>nil, \"location\"=>{}, \"encounter_diagnosis\"=>{\"code_point\"=>\"386661006\", \"code_system\"=>\"SNOMEDCT\", \"description\"=>\"Fever (finding)\"}, \"performer\"=>nil, \"consult_note\"=>nil, \"history_and_physical_note\"=>nil, \"reason_for_referral\"=>\"None\", \"progress_note\"=>nil, \"author\"=>{\"name\"=>\"Albert Davis\", \"identifier\"=>1008, \"location\"=>\"office\"}, \"status\"=>nil}"
          }
        ],
        "status": "finished",
        "class": {
          "code": "AMB",
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "display": "ambulatory"
        },
        "type": [
          {
            "coding": [
              {
                "code": "386661006",
                "system": "http://snomed.info/sct"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/1",
          "display": "Alice, Newman"
        },
        "participant": [
          {
            "type": [
              {
                "coding": [
                  {
                    "code": "PPRF",
                    "display": "primary performer"
                  }
                ],
                "text": "Primary Performer"
              }
            ],
            "period": {
              "start": "2015-06-22T00:00:00-04:00",
              "end": null
            },
            "individual": {
              "reference": "Practitioner/1008",
              "display": "Albert Davis"
            }
          }
        ],
        "period": {
          "start": "2015-06-22T00:00:00-04:00",
          "end": null
        },
        "reasonCode": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "386661006"
              }
            ]
          }
        ],
        "hospitalization": {
          "dischargeDisposition": {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "386661006"
              }
            ]
          }
        },
        "location": [
          {
            "location": {
              "reference": "Organization/"
            }
          }
        ],
        "serviceProvider": {
          "reference": "Organization/",
          "type": "Organization"
        }
      }
    },
    {
      "full_url": "/Encounter/1002",
      "resource": {
        "resourceType": "Encounter",
        "id": "1002",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
          ]
        },
        "identifier": [
          {
            "type": {
              "coding": [
                {
                  "code": "MR",
                  "display": "Medical record number"
                }
              ],
              "text": "Medical record number"
            },
            "system": null,
            "value": "{\"patient_name\"=>{\"first_name\"=>\"Alice\", \"preferred_name\"=>\"Alice\", \"middle_name\"=>\"Jones\", \"suffix\"=>nil, \"last_name\"=>\"Newman\", \"birth_name\"=>\"Alicia\", \"previous_first_name\"=>\"Alicia\", \"previous_middle_name\"=>\"Jones\", \"previous_last_name\"=>\"Newman\"}, \"identifier\"=>1002, \"name\"=>\"Dependence on walking stick (finding)\", \"code\"=>\"105504002\", \"code_system\"=>\"2.16.840.1.113883.6.96\", \"code_system_name\"=>\"SNOMEDCT\", \"admit_date\"=>\"2005-05-01T00:00:00.000-04:00\", \"discharge_date\"=>nil, \"location\"=>{}, \"encounter_diagnosis\"=>{\"description\"=>\"Dependence on walking stick (finding)\", \"code_point\"=>\"105504002\"}, \"performer\"=>nil, \"consult_note\"=>nil, \"history_and_physical_note\"=>nil, \"reason_for_referral\"=>\"None\", \"progress_note\"=>nil, \"author\"=>{\"name\"=>\"Albert Davis\", \"identifier\"=>1008, \"location\"=>\"office\"}, \"status\"=>nil}"
          }
        ],
        "status": "finished",
        "class": {
          "code": "AMB",
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "display": "ambulatory"
        },
        "type": [
          {
            "coding": [
              {
                "code": "105504002",
                "system": "http://www.ama-assn.org/go/cpt"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/1",
          "display": "Alice, Newman"
        },
        "participant": [
          {
            "type": [
              {
                "coding": [
                  {
                    "code": "PPRF",
                    "display": "primary performer"
                  }
                ],
                "text": "Primary Performer"
              }
            ],
            "period": {
              "start": "2005-05-01T00:00:00-04:00",
              "end": null
            },
            "individual": {
              "reference": "Practitioner/1008",
              "display": "Albert Davis"
            }
          }
        ],
        "period": {
          "start": "2005-05-01T00:00:00-04:00",
          "end": null
        },
        "reasonCode": [
          {
            "coding": [
              {
                "system": "http://www.ama-assn.org/go/cpt",
                "code": "105504002"
              }
            ]
          }
        ],
        "hospitalization": {
          "dischargeDisposition": {
            "coding": [
              {
                "system": "http://www.ama-assn.org/go/cpt",
                "code": "105504002"
              }
            ]
          }
        },
        "location": [
          {
            "location": {
              "reference": "Organization/"
            }
          }
        ],
        "serviceProvider": {
          "reference": "Organization/",
          "type": "Organization"
        }
      }
    },
    {
      "full_url": "/Encounter/1003",
      "resource": {
        "resourceType": "Encounter",
        "id": "1003",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
          ]
        },
        "identifier": [
          {
            "type": {
              "coding": [
                {
                  "code": "MR",
                  "display": "Medical record number"
                }
              ],
              "text": "Medical record number"
            },
            "system": null,
            "value": "{\"patient_name\"=>{\"first_name\"=>\"Alice\", \"preferred_name\"=>\"Alice\", \"middle_name\"=>\"Jones\", \"suffix\"=>nil, \"last_name\"=>\"Newman\", \"birth_name\"=>\"Alicia\", \"previous_first_name\"=>\"Alicia\", \"previous_middle_name\"=>\"Jones\", \"previous_last_name\"=>\"Newman\"}, \"identifier\"=>1003, \"name\"=>\"Amnesia (finding)\", \"code\"=>\"48167000\", \"code_system\"=>\"2.16.840.1.113883.6.96\", \"code_system_name\"=>\"SNOMEDCT\", \"admit_date\"=>\"2005-05-01T00:00:00.000-04:00\", \"discharge_date\"=>nil, \"location\"=>{}, \"encounter_diagnosis\"=>{\"description\"=>\"Amnesia (finding)\", \"code_point\"=>\"48167000\"}, \"performer\"=>nil, \"consult_note\"=>nil, \"history_and_physical_note\"=>nil, \"reason_for_referral\"=>\"None\", \"progress_note\"=>nil, \"author\"=>{\"name\"=>\"Albert Davis\", \"identifier\"=>1008, \"location\"=>\"office\"}, \"status\"=>nil}"
          }
        ],
        "status": "finished",
        "class": {
          "code": "AMB",
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "display": "ambulatory"
        },
        "type": [
          {
            "coding": [
              {
                "code": "48167000",
                "system": "http://www.ama-assn.org/go/cpt"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/1",
          "display": "Alice, Newman"
        },
        "participant": [
          {
            "type": [
              {
                "coding": [
                  {
                    "code": "PPRF",
                    "display": "primary performer"
                  }
                ],
                "text": "Primary Performer"
              }
            ],
            "period": {
              "start": "2005-05-01T00:00:00-04:00",
              "end": null
            },
            "individual": {
              "reference": "Practitioner/1008",
              "display": "Albert Davis"
            }
          }
        ],
        "period": {
          "start": "2005-05-01T00:00:00-04:00",
          "end": null
        },
        "reasonCode": [
          {
            "coding": [
              {
                "system": "http://www.ama-assn.org/go/cpt",
                "code": "48167000"
              }
            ]
          }
        ],
        "hospitalization": {
          "dischargeDisposition": {
            "coding": [
              {
                "system": "http://www.ama-assn.org/go/cpt",
                "code": "48167000"
              }
            ]
          }
        },
        "location": [
          {
            "location": {
              "reference": "Organization/"
            }
          }
        ],
        "serviceProvider": {
          "reference": "Organization/",
          "type": "Organization"
        }
      }
    }
  ],
  "total": 4
}

Params

Param name Description
access_token
required

CarePaths User OAuth Token

Validations:

  • Must be String.
patient
optional

ID of the requested patient

Validations:

  • Must be number.
start_date
optional

Start date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.
end_date
optional

End date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Encounter

Validations:

  • Must be String.
identifier
required

Validations:

  • Must be Array.
status
required

Validations:

  • Must be String.
__class__
required

Validations:

  • Must be Hash.
type
required

Validations:

  • Must be Array.
subject
required

Validations:

  • Must be Hash.
participant
required

Validations:

  • Must be Array.
period
required

Validations:

  • Must be Hash.
reason_code
required

Validations:

  • Must be Array.
hospitalization
required

Validations:

  • Must be Hash.
location
required

Validations:

  • Must be Array.
service_provider
required

Validations:

  • Must be Hash.
>>>

GET /Encounter:id
Encounters by id

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Examples

GET /Encounter/1009?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Encounter",
  "id": "1009",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
    ]
  },
  "identifier": [
    {
      "type": {
        "coding": [
          {
            "code": "MR",
            "display": "Medical record number"
          }
        ],
        "text": "Medical record number"
      },
      "system": null,
      "value": "{\"patient_name\"=>{\"first_name\"=>\"Alice\", \"preferred_name\"=>\"Alice\", \"middle_name\"=>\"Jones\", \"suffix\"=>nil, \"last_name\"=>\"Newman\", \"birth_name\"=>\"Alicia\", \"previous_first_name\"=>\"Alicia\", \"previous_middle_name\"=>\"Jones\", \"previous_last_name\"=>\"Newman\"}, \"identifier\"=>1009, \"name\"=>\"Clinician Progress Note\", \"code\"=>\"90837\", \"code_system\"=>\"2.16.840.1.113883.6.12\", \"code_system_name\"=>\"CPT\", \"admit_date\"=>\"20210801\", \"discharge_date\"=>\"20210801\", \"location\"=>\"\", \"encounter_diagnosis\"=>{}, \"performer\"=>{\"first_name\"=>\"Albert\", \"last_name\"=>\"Davis\", \"display_name\"=>\"Albert Davis\", \"address_line_1\"=>\"2472, Rocky place\", \"city\"=>\"Beaverton\", \"state\"=>\"FL\", \"postal_code\"=>\"97006\", \"tel\"=>nil}, \"consult_note\"=>\"\", \"history_and_physical_note\"=>\"\", \"reason_for_referral\"=>\"\", \"progress_note\"=>\"\", \"author\"=>{\"current_time\"=>\"2021-08-01\"}}"
    }
  ],
  "status": "finished",
  "class": {
    "code": "AMB",
    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
    "display": "ambulatory"
  },
  "type": [
    {
      "coding": [
        {
          "code": "",
          "system": "http://www.ama-assn.org/go/cpt"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/1",
    "display": "Alice, Newman"
  },
  "participant": [
    {
      "type": [
        {
          "coding": [
            {
              "code": "PPRF",
              "display": "primary performer"
            }
          ],
          "text": "Primary Performer"
        }
      ],
      "period": {
        "start": "2021-08-01T00:00:00+00:00",
        "end": "2021-08-01T00:00:00+00:00"
      },
      "individual": {
        "reference": "Practitioner/",
        "display": null
      }
    }
  ],
  "period": {
    "start": "2021-08-01T00:00:00+00:00",
    "end": "2021-08-01T00:00:00+00:00"
  },
  "reasonCode": [
    {
      "coding": [
        {
          "system": "http://www.ama-assn.org/go/cpt",
          "code": ""
        }
      ]
    }
  ],
  "hospitalization": {
    "dischargeDisposition": {
      "coding": [
        {
          "system": "http://www.ama-assn.org/go/cpt",
          "code": ""
        }
      ]
    }
  },
  "location": [
    {
      "location": {
        "reference": "Organization/"
      }
    }
  ],
  "serviceProvider": {
    "reference": "Organization/",
    "type": "Organization"
  }
}

Params

Param name Description
access_token
required

CarePaths User OAuth Token

Validations:

  • Must be String.
id
optional

ID of requested encounter

Validations:

  • Must be number.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Encounter

Validations:

  • Must be String.
identifier
required

Validations:

  • Must be Array.
status
required

Validations:

  • Must be String.
__class__
required

Validations:

  • Must be Hash.
type
required

Validations:

  • Must be Array.
subject
required

Validations:

  • Must be Hash.
participant
required

Validations:

  • Must be Array.
period
required

Validations:

  • Must be Hash.
reason_code
required

Validations:

  • Must be Array.
hospitalization
required

Validations:

  • Must be Hash.
location
required

Validations:

  • Must be Array.
service_provider
required

Validations:

  • Must be Hash.
>>>

GET /Encounter/_search
Encounters search

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Params

Param name Description
access_token
required

CarePaths User OAuth Token

Validations:

  • Must be String.
patient
optional

ID of the requested patient

Validations:

  • Must be number.
start_date
optional

Start date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.
end_date
optional

End date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.