Mismatch between the REST API Swagger and Manual Documentation - which is which

Development
, ,
4

From our experience, using the bundled documentation is better as its more descriptive compared to the https://rest.openmrs.org/?shell#list-encounters documentation. However, the bundled documentation is missing some important properties such as Visit information that extremely relevant to an encounter.

Below is a draft JOSN Body used in UgandaEMR to create an encounter using REST.

{
  "encounterDatetime": "currentdatetime",
  "patient": "patient_uuid",
  "encounterType": "encounterType_uuid",
  "location": "location_uuid",
  "visit": {
    "patient": "patient_uuid",
    "visitType": "visit_uuid",
    "startDatetime": "currentdatetime"
  },
  "encounterProviders": [
    {
      "provider": "provider_uuid",
      "encounterRole": "encounter_role_uuid"
    }
  ],
  "obs": [
    {
      "person": "patient_uuid",
      "concept": "obs_concept_uuid",
      "obsDatetime": "currentdatetime",
      "value": "obs_value"
    },
    {
      "person": "patient_uuid",
      "concept": "obs_concept_uuid",
      "obsDatetime": "currentdatetime",
      "value": "obs_value"
    },
    {
      "person": "patient_uuid",
      "concept": "obs_coded_concept_uuid",
      "obsDatetime": "currentdatetime",
      "valueCodedName": "Current Regimen",
      "value": "coded_concept_answer_uuid"
    }
  ]
}
1 Like