NAV Navbar
Logo cerner
Ruby Shell

Wellness User Registration API v1

The Wellness User Registration API facilitates user registration for the Wellness Application service. During the user registration workflow, the user verifies his or her identity, signs up, and associates the account with a consumer record in HealtheIntent. Users must register to use applications that use the service, and users must have a valid eligibility record to register.

URL: https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1

eligibility-records

An eligibility record indicates that a person is eligible to be included in the Wellness Application service for a tenant. The record includes demographic information such as a date of birth and email address that can be used to validate the person’s identity. The record also includes the consumer ID with which the user is associated as part of the registration.

Retrieve a List of Eligibility Records

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
      "consumerId": "496753ec-da5b-4202-b8cb-d4bf373af597",
      "dateOfBirth": "1990-09-20",
      "familyName": "Sanchez",
      "memberIdentifier": "493499524083",
      "telecoms": [
        {
          "system": "EMAIL",
          "value": "jane.smith@cerner.com"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records?offset=0&limit=20"
}

GET /eligibility-records

Retrieves all the eligibility records for a given tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
telecomValue query string false N/A Filters by the telecom value associated with an eligibility record. -
consumerId query string false N/A Filters by the ID of the consumer. -
memberIdentifier query string false N/A Filters by the member ID of the eligibility record. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success EligibilityRecords
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create an Eligibility Record

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records', headers: headers, body: {"consumerId":"496753ec-da5b-4202-b8cb-d4bf373af597","dateOfBirth":"1990-09-20","familyName":"Sanchez","memberIdentifier":"493499524083","telecoms":[{"system":"EMAIL","value":"jane.smith@cerner.com"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumerId":"496753ec-da5b-4202-b8cb-d4bf373af597","dateOfBirth":"1990-09-20","familyName":"Sanchez","memberIdentifier":"493499524083","telecoms":[{"system":"EMAIL","value":"jane.smith@cerner.com"}]}

Example response

{
  "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "consumerId": "496753ec-da5b-4202-b8cb-d4bf373af597",
  "dateOfBirth": "1990-09-20",
  "familyName": "Sanchez",
  "memberIdentifier": "493499524083",
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "jane.smith@cerner.com"
    }
  ]
}

POST /eligibility-records

Creates an eligibility record for a given tenant. The consumer ID, telecom value, and member ID must be unique for the tenant. One of the following combinations is required to create an eligibility record:

Parameters

Parameter In Type Required Default Description Accepted Values
body body postEligibilityRecords true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created EligibilityRecord
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the created eligibility record.

Remove an Eligibility Record

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records/772adbb6-d0c9-46e1-acd5-a5c07c325f88', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records/772adbb6-d0c9-46e1-acd5-a5c07c325f88 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /eligibility-records/{eligibilityRecordId}

Removes an eligibility record for a given tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
eligibilityRecordId path string true N/A The ID of the eligibility record. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update an Eligibility Record

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records/772adbb6-d0c9-46e1-acd5-a5c07c325f88', headers: headers, body: {"consumerId":"496753ec-da5b-4202-b8cb-d4bf373af597","dateOfBirth":"1990-09-20","familyName":"Sanchez","memberIdentifier":"493499524083","telecoms":[{"system":"EMAIL","value":"jane.smith@cerner.com"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records/772adbb6-d0c9-46e1-acd5-a5c07c325f88 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumerId":"496753ec-da5b-4202-b8cb-d4bf373af597","dateOfBirth":"1990-09-20","familyName":"Sanchez","memberIdentifier":"493499524083","telecoms":[{"system":"EMAIL","value":"jane.smith@cerner.com"}]}

PUT /eligibility-records/{eligibilityRecordId}

Updates the attributes of an eligibility record for a given tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
eligibilityRecordId path string true N/A The ID of the eligibility record. -
body body putEligibilityRecords true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Eligibility Record

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records/772adbb6-d0c9-46e1-acd5-a5c07c325f88', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-user-registration/v1/eligibility-records/772adbb6-d0c9-46e1-acd5-a5c07c325f88 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "consumerId": "496753ec-da5b-4202-b8cb-d4bf373af597",
  "dateOfBirth": "1990-09-20",
  "familyName": "Sanchez",
  "memberIdentifier": "493499524083",
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "jane.smith@cerner.com"
    }
  ]
}

GET /eligibility-records/{eligibilityRecordId}

Retrieves a single eligibility record for a given tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
eligibilityRecordId path string true N/A The ID of the eligibility record. -

Response Statuses

Status Meaning Description Schema
200 OK Success EligibilityRecord
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Schema Definitions

EligibilityRecords

Name Type Required Description Accepted Values
items [EligibilityRecord] true [Retrieves a single eligibility record for a given tenant.] -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

EligibilityRecord

Name Type Required Description Accepted Values
id string true The ID of the eligibility record. -
consumerId string true The ID of the consumer. -
dateOfBirth string false The date of birth of the consumer, in ISO 8601 format YYYY-MM-DD. -
familyName string false The family name of the consumer. -
memberIdentifier string false The tenant-configurable ID that identifies the consumer. -
telecoms [Telecom] false The contact details of the consumer. -

Telecom

Name Type Required Description Accepted Values
system string true The system of the telecom. EMAIL
value string true The value for the telecom. -

UnauthorizedError

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [UnauthorizedErrorErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false Codified value representing the specific error resulting in the current error status. -
message string false Human readable description of an error. -
locationType string false Location or type of the field that caused an error. query, header, path, formData, body
location string false Name of the field that caused an error. -

UnauthorizedErrorErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

ForbiddenError

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ForbiddenErrorDetail] false A list of additional error details. -

ForbiddenErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

BadRequestError

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [BadRequestErrorDetail] false A list of additional error details. -

BadRequestErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

postEligibilityRecords

Name Type Required Description Accepted Values
consumerId string true The ID of the consumer. -
dateOfBirth string false The date of birth of the consumer, in ISO 8601 format YYYY-MM-DD. -
familyName string false The family name of the consumer. -
memberIdentifier string false The tenant-configurable ID that identifies the consumer. -
telecoms [object] false The contact details of the consumer. -
» system string true The system of the telecom. -
» value string true The value for the telecom. -

NotFoundError

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [NotFoundErrorDetail] false A list of additional error details. -

NotFoundErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

putEligibilityRecords

Name Type Required Description Accepted Values
consumerId string true The ID of the consumer. -
dateOfBirth string false The date of birth of the consumer, in ISO 8601 format YYYY-MM-DD. -
familyName string false The family name of the consumer. -
memberIdentifier string false The tenant-configurable ID that identifies the consumer. -
telecoms [object] false The contact details of the consumer. -
» system string true The system of the telecom. -
» value string true The value for the telecom. -