Releasesv0.1.0
Api referenceEndpointsFhir

One FHIR R4 Device

GET
/v1/users/{id}/fhir/Device/{device_id}

The Device an Observation references. A device none of the user's records names is a 404.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid
device_id*string

The Device id, as an Observation's device.reference gives it.

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The Device.

application/fhir+json
  1. response

A device the user's records came from, as a FHIR R4 Device (docs/fhir.md).

resourceType*string
id*string
Match^dev-[0-9a-f]{16}$
meta?
identifier?array<>

The provider's device id (provenance device), when known.

deviceName?array<>

The device model (device_model), when known.

modelNumber?string

The product type (product_type), when known.

patient?
curl -X GET 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/fhir/Device/dev-4cd59d3e7b09cd28' \  -H 'Authorization: Bearer ohs_sk_...'
{  "resourceType": "Device",  "id": "dev-4cd59d3e7b09cd28",  "meta": {    "source": "http://example.com",    "profile": [      "http://example.com"    ],    "tag": [      {        "system": "http://example.com",        "code": "string",        "display": "string"      }    ]  },  "identifier": [    {      "system": "http://example.com",      "value": "string"    }  ],  "deviceName": [    {      "name": "string",      "type": "model-name"    }  ],  "modelNumber": "string",  "patient": {    "reference": "Patient/3f0c2f8e-8b8a-4c55-9f5e-2b0f3a1d9c11",    "identifier": {      "system": "http://example.com",      "value": "string"    },    "display": "string"  }}
Edit on GitHub