Skip to main content
Read Encounter
curl --request GET \
  --url https://{tenant_id}.api.nestmed.com/fhir/r4/Encounter/{id} \
  --header 'Authorization: Bearer <token>'
{
  "resourceType": "Encounter",
  "status": "planned",
  "class": {
    "system": "<string>",
    "version": "<string>",
    "code": "<string>",
    "display": "<string>",
    "userSelected": true
  },
  "id": "<string>",
  "meta": {
    "versionId": "<string>",
    "lastUpdated": "2023-11-07T05:31:56Z",
    "source": "<string>",
    "profile": [
      "<string>"
    ],
    "security": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ],
    "tag": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ]
  },
  "text": {
    "status": "generated",
    "div": "<string>"
  },
  "extension": [
    {
      "url": "<string>",
      "valueBoolean": true,
      "valueInteger": 123,
      "valueDecimal": 123,
      "valueString": "<string>",
      "valueUri": "<string>",
      "valueDate": "2023-12-25",
      "valueDateTime": "2023-11-07T05:31:56Z",
      "valueCode": "<string>",
      "valueCoding": {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "valueQuantity": {
        "value": 123,
        "comparator": "<",
        "unit": "<string>",
        "system": "<string>",
        "code": "<string>"
      },
      "valuePeriod": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "valueReference": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "valueAttachment": {
        "contentType": "<string>",
        "language": "<string>",
        "data": "aSDinaTvuI8gbWludGxpZnk=",
        "url": "<string>",
        "size": 123,
        "hash": "<string>",
        "title": "<string>",
        "creation": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    }
  ],
  "statusHistory": [
    {
      "status": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "classHistory": [
    {
      "class": {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      },
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "type": [
    {
      "coding": [
        {
          "system": "<string>",
          "version": "<string>",
          "code": "<string>",
          "display": "<string>",
          "userSelected": true
        }
      ],
      "text": "<string>"
    }
  ],
  "serviceType": {
    "coding": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ],
    "text": "<string>"
  },
  "priority": {
    "coding": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ],
    "text": "<string>"
  },
  "subject": {
    "reference": "<string>",
    "type": "<string>",
    "identifier": {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    },
    "display": "<string>"
  },
  "episodeOfCare": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "basedOn": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "participant": [
    {
      "type": [
        {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        }
      ],
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "individual": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      }
    }
  ],
  "appointment": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "period": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "length": {
    "value": 123,
    "comparator": "<",
    "unit": "<string>",
    "system": "<string>",
    "code": "<string>"
  },
  "reasonCode": [
    {
      "coding": [
        {
          "system": "<string>",
          "version": "<string>",
          "code": "<string>",
          "display": "<string>",
          "userSelected": true
        }
      ],
      "text": "<string>"
    }
  ],
  "reasonReference": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "diagnosis": [
    {
      "condition": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "use": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "rank": 123
    }
  ],
  "account": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "hospitalization": {
    "preAdmissionIdentifier": {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    },
    "origin": {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    },
    "admitSource": {
      "coding": [
        {
          "system": "<string>",
          "version": "<string>",
          "code": "<string>",
          "display": "<string>",
          "userSelected": true
        }
      ],
      "text": "<string>"
    },
    "reAdmission": {
      "coding": [
        {
          "system": "<string>",
          "version": "<string>",
          "code": "<string>",
          "display": "<string>",
          "userSelected": true
        }
      ],
      "text": "<string>"
    },
    "dietPreference": [
      {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      }
    ],
    "specialCourtesy": [
      {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      }
    ],
    "specialArrangement": [
      {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      }
    ],
    "destination": {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    },
    "dischargeDisposition": {
      "coding": [
        {
          "system": "<string>",
          "version": "<string>",
          "code": "<string>",
          "display": "<string>",
          "userSelected": true
        }
      ],
      "text": "<string>"
    }
  },
  "location": [
    {
      "location": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "status": "planned",
      "physicalType": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "serviceProvider": {
    "reference": "<string>",
    "type": "<string>",
    "identifier": {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    },
    "display": "<string>"
  },
  "partOf": {
    "reference": "<string>",
    "type": "<string>",
    "identifier": {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    },
    "display": "<string>"
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

Query Parameters

_include
string

Response

Encounter resource

resourceType
enum<string>
required
Available options:
Encounter
status
enum<string>
required
Available options:
planned,
arrived,
triaged,
in-progress,
onleave,
finished,
cancelled,
entered-in-error,
unknown
class
object
required
id
string
meta
object
text
object
extension
object[]
identifier
object[]
statusHistory
object[]
classHistory
object[]
type
object[]
serviceType
object
priority
object
subject
object
episodeOfCare
object[]
basedOn
object[]
participant
object[]
appointment
object[]
period
object
length
object
reasonCode
object[]
reasonReference
object[]
diagnosis
object[]
account
object[]
hospitalization
object
location
object[]
serviceProvider
object
partOf
object