Dataset: Health

Dataset name: ds_health

Description

High-level health and GP details.

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Member's CHI number	field_health_chi_number	The member's CHI number	varchar	www.terrace-medical-practice.com
GP Details Country	field_health_gp_country	The country of the member's GP	text
GP Details County	field_health_gp_county	The county of the member's GP	text
GP Details Email	field_health_gp_email	The email address of the member's GP	text
GP Details Fax	field_health_gp_fax	The fax address of the member's GP	text
GP Details GP Name	field_health_gp_name	The name of the member's GP	text
GP Details Postcode	field_health_gp_postcode	The postcode of the member's GP	text
GP Practice Name	field_health_gp_practice_name	The name of the members GP practice	varchar	Terrace Medical Practice
GP Practice Website	field_health_gp_practice_website	The website for the members GP practice	varchar	www.terrace-medical-practice.com
GP Details Street	field_health_gp_street	The street address of the member's GP	text
GP Details Telephone	field_health_gp_telephone	The telephone number of the member's GP	text
GP Details Town	field_health_gp_town	The town of the member's GP	text
NHS Number	field_health_nhs_number	The member's NHS number	text
Social Care ID	field_health_social_care_id	The member's social care ID	text

---

Making an API request for this Dataset

Example Request to the Sandbox Server

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

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

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.

The connection's read/write permissions are listed for each field. All instances of an accessible dataset are indexed with instance_N notation from N=0.

{
  "1": {
    "id": "1",
    "field_health_chi_number": "www.terrace-medical-practice.com",
    "field_health_gp_country": null,
    "field_health_gp_county": null,
    "field_health_gp_email": null,
    "field_health_gp_fax": null,
    "field_health_gp_name": null,
    "field_health_gp_postcode": null,
    "field_health_gp_practice_name": "Terrace Medical Practice",
    "field_health_gp_practice_website": "www.terrace-medical-practice.com",
    "field_health_gp_street": null,
    "field_health_gp_telephone": null,
    "field_health_gp_town": null,
    "field_health_nhs_number": null,
    "field_health_social_care_id": null
  }
}