Membership

Membership Example Object

{
  "membership":{
    "id":3,
    "email":"jane@patient.com",
    "member_id":null,
    "state":"active",
    "type":"memberships",
    "patient":{
      "address":null,
      "dob":"2005-01-11T00:00:00Z",
      "external_id":null,
      "first_name":"Jane",
      "gender":"female",
      "id":3,
      "last_name":"Patient",
      "middle_name":null,
      "phone":null,
      "primary_care_physician":null,
      "type":"patients",
      "zipcode":"80202"
    },
    "metadata":{
      "referring_hospital":"St Vincents"
    },
    "plan":{
      "id":7,
      "active":true,
      "created_at":"2016-09-28T23:33:32Z",
      "description":"Urgent Care",
      "external_id":"hijklm",
      "name":"Plan 1",
      "provider_group":{
        "id":2,
        "created_at":"2016-09-28T23:33:32Z",
        "external_id":null,
        "name":"Family Practice",
        "type":"provider_groups"
      },
      "type":"plans"
    }
  }
}

Membership Fields

Field	Description
id	Membership ID
email	Membership email
member_id	Unique Member ID
state	Membership Active Status
type	Membership Type
patient	Patient Object
metadata	Membership Metadata (clinical metadata)
plan	Plan Object

Patient

Patient Example Object

{
  "patient":{
    "address":null,
    "dob":"2005-01-11T00:00:00Z",
    "external_id":null,
    "first_name":"Jane",
    "gender":"female",
    "id":3,
    "last_name":"Patient",
    "middle_name":null,
    "phone":null,
    "primary_care_physician":null,
    "type":"patients",
    "zipcode":"80202"
  }
}

Patient Fields

Field	Description
address	Patient Address
dob	Timestamp in which the patient was born
external_id	Patient External ID
first_name	Patient First Name
gender	Patient Gender
id	Unique Patient ID
last_name	Patient Last Name
middle_name	Patient Middle Name
phone	Patient Phone Number
primary_care_physician	Patient’s Primary Care Physician
type	Patient Type
zipcode	Patient Zipcode

Provider

Provider Example Object

{
  "provider": {
    "id": 1,
    "type": "providers",
    "first_name": "Jann",
    "last_name": "Vincent",
    "provider_identifier": null
  }
}

Provider Fields

Field	Description
id	Provider ID
type	Provider Type
first_name	Provider First Name
last_name	Provider Last Name
provider_identifier	Provider Identifier

Provider Group

Provider Group Example Object

{
  "provider_group": {
    "id": 2,
    "type": "provider_groups",
    "name": "Family Practice",
    "external_id": null,
    "created_at":"2016-09-28T23:33:32Z"
  }
}

Provider Group Fields

Field	Type	Description
id	Integer	Primary ID of the ProviderGroup for the Plan with CirrusMD
type	String	Polymorphic type of the ProviderGroup. Is always “provider_groups” for a ProviderGroup
name	String	Optional description of the ProviderGroup
external_id	Integer	Primary ID of the ProviderGroup outside of CirrusMD
created_at	ISO8601	Time at which the ProviderGroup was created with CirrusMD

ICD Codes

ICD Code Example Object

{
  "icd_codes":[
    {
      "id":32,
      "code":"B34.9",
      "description":"Viral infection, unspecified",
      "primary":true,
      "type":"icd_codes"
    },
    {
      "id":812,
      "code":"J06.9",
      "description":"Acute upper respiratory infection, unspecified",
      "primary":false,
      "type":"icd_codes"
    }
  ]
}

ICD Code Fields

Field	Description
id	ICD Code ID
code	ICD Code
description	ICD Code Description
primary	ICD Primary Code
type	ICD Code Type