Dataset: Health and Social Care Records

Dataset name: ds_hscr

Description

Health and Social Care Records

Fields in this dataset

Name Field Name Description Field Type Field Example
Created Timestamp created_timestamp Created Timestamp. int
Delivery Timestamp delivery_timestamp Timestamp of when the data payload was delivered to the PDS. int
HSCR Data hscr_data The full data from the originating source in whatever format it was delivered. blob
HSCR Data Format hscr_data_format This tells us what data structure standard we are receiving e.g OpenEHR, HL7,FHIR. varchar
HSCR Data Source hscr_data_source The data source that this HSCR originated from. varchar
HSCR Delivery route hscr_delivery_route The name of the delivery route e.g. Health Data Exchange, Lenus Platform. varchar
HSCR Title hscr_title Extracted from the payload a human readable name for the data payload. varchar
HSCR ID id The primary identifier for this record. serial
HSCR Instance instance The instance this item relates to. int
HSCR Source source The source of the data - user or connection. varchar
HSCR Source ID source_id This will be meta data about the record from the source. varchar
HSCR Source Version source_version If we can extract from the meta data about the payload a version number we should do so. varchar
Updated By updated_by The human readable name of the connection who updated an existing record provided by either themselves varchar
Updated Timestamp updated_timestamp Updated Timestamp. int

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/hscr/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_hscr
  &instance=0

Replace the following with your own details: UID KEY, API_KEY and CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

{
  "": {
    "id": null,
    "ds_id": null,
    "created_timestamp": null,
    "delivery_timestamp": null,
    "hscr_data": null,
    "hscr_data_format": null,
    "hscr_data_source": null,
    "hscr_delivery_route": null,
    "hscr_title": null,
    "source_id": null,
    "source_version": null,
    "updated_by": null,
    "updated_timestamp": null
  }
}