Related_persons

To define

Supported Formats

json
>>>

GET /api/RelatedPerson
Related Persons

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

RelatedPerson

Validations:

  • Must be String.
patient
required

Validations:

  • Must be Hash.
active
required

Validations:

  • Must be Boolean.
relationship
required

Validations:

  • Must be Array.
name
required

Validations:

  • Must be Array.
telecom
required

Validations:

  • Must be Array.
address
required

Validations:

  • Must be Array.
>>>

GET /api/RelatedPerson/:id
Related Person by ID

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

RelatedPerson

Validations:

  • Must be String.
patient
required

Validations:

  • Must be Hash.
active
required

Validations:

  • Must be Boolean.
relationship
required

Validations:

  • Must be Array.
name
required

Validations:

  • Must be Array.
telecom
required

Validations:

  • Must be Array.
address
required

Validations:

  • Must be Array.