api-docs v5.116.0

API Docs

Table of contents

Medical_Record

Allergy - Delete

Back to top

Delete an allergy medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

allergy
subtype String
name String
description String
startedAt Number
supplement String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "allergy",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Allergy - Find

Back to top

Get allergy medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=allergy" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

allergy
medicalRecords.subtype String
medicalRecords.name String
medicalRecords.description String
medicalRecords.startedAt Number
medicalRecords.supplement String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "allergy",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "allergy",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Allergy - Get

Back to top

Get an allergy medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

allergy
subtype String
name String
description String
startedAt Number
supplement String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "allergy",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Allergy - Patch

Back to top

Update an allergy medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
name String
description String optional
startedAt Number optional
supplement String optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "name": "some-allergy-name",
    "description": "allergy description",
    "supplement": "allergy supplement"
  }'

Parameters examples

json - Request-Example

{
  "name": "some-allergy-name",
  "description": "allergy description",
  "supplement": "allergy supplement"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

allergy
subtype String
name String
description String
startedAt Number
supplement String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "allergy",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Allergy - Post

Back to top

Create a medical record for allergy

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: "allergy"
subtype String optional
name String
description String optional
startedAt Number optional
supplement String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "allergy",
    "name": "some-allergy-name",
    "description": "allergy description",
    "supplement": "allergy supplement"
  }'

Parameters examples

json - Request-Example

{
  "type": "allergy",
  "name": "some-allergy-name",
  "decsription": "allergy medical record description"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

allergy
subtype String
name String
description String
startedAt Number
supplement String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "allergy",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

APE Report - Delete

Back to top

Delete an APE report medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ape-report
subtype String
contract String
classification String
report String
template String

form template id
data Object
values Object[]
values.id String

form input id
values.answer Any
values.answers Any[]
examinedBy String

examining physician
reviewedBy String

reviewer of the report
deliveryAcknowldgement String

reference to the delivery receipt
deliveredAt Number
classifiedAt Number
classifiedBy String
doneAt Number
doneBy String
processedBy String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ape-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

APE Report - Find

Back to top

Get APE report medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=ape-report" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

ape-report
medicalRecords.subtype String
medicalRecords.contract String
medicalRecords.classification String
medicalRecords.report String
medicalRecords.template String

form template id
medicalRecords.data Object
medicalRecords.values Object[]
medicalRecords.values.id String

form input id
medicalRecords.values.answer Any
medicalRecords.values.answers Any[]
medicalRecords.examinedBy String

examining physician
medicalRecords.reviewedBy String

reviewer of the report
medicalRecords.deliveryAcknowldgement String

reference to the delivery receipt
medicalRecords.deliveredAt Number
medicalRecords.classifiedAt Number
medicalRecords.classifiedBy String
medicalRecords.doneAt Number
medicalRecords.doneBy String
medicalRecords.processedBy String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "ape-report",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "ape-report",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

APE Report - Get

Back to top

Get an APE report medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ape-report
subtype String
contract String
classification String
report String
template String

form template id
data Object
values Object[]
values.id String

form input id
values.answer Any
values.answers Any[]
examinedBy String

examining physician
reviewedBy String

reviewer of the report
deliveryAcknowldgement String

reference to the delivery receipt
deliveredAt Number
classifiedAt Number
classifiedBy String
doneAt Number
doneBy String
processedBy String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ape-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

APE Report - Patch

Back to top

Update an APE report medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
contract String optional
classification String optional
report String optional
template String optional

form template id
data Object optional
values Object[] optional
values.id String

form input id
values.answer Any
values.answers Any[]
examinedBy String optional

examining physician
reviewedBy String optional

reviewer of the report
deliveryAcknowldgement String optional

reference to the delivery receipt
deliveredAt Number optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "template": "some-template-id",
    "deliveredAt": "123123123"
  }'

Parameters examples

json - Request-Example

{
  "template": "some-template-id",
  "deliveredAt": "123123123"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ape-report
subtype String
contract String
classification String
report String
template String

form template id
data Object
values Object[]
values.id String

form input id
values.answer Any
values.answers Any[]
examinedBy String

examining physician
reviewedBy String

reviewer of the report
deliveryAcknowldgement String

reference to the delivery receipt
deliveredAt Number
classifiedAt Number
classifiedBy String
doneAt Number
doneBy String
processedBy String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ape-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

APE Report - Post

Back to top

Create a medical record for APE report

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: "ape-report"
subtype String optional
contract String optional
classification String optional
report String optional
template String optional

form template id
data Object optional
values Object[] optional
values.id String

form input id
values.answer Any
values.answers Any[]
examinedBy String optional

examining physician
reviewedBy String optional

reviewer of the report
deliveryAcknowldgement String optional

reference to the delivery receipt
deliveredAt Number optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "ape-report",
    "template": "some-template-id",
    "deliveredAt": "123123123"
  }'

Parameters examples

json - Request-Example

{
  "type": "ape-report",
  "template": "some-template-id",
  "deliveredAt": "123123123"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ape-report
subtype String
contract String
classification String
report String
template String

form template id
data Object
values Object[]
values.id String

form input id
values.answer Any
values.answers Any[]
examinedBy String

examining physician
reviewedBy String

reviewer of the report
deliveryAcknowldgement String

reference to the delivery receipt
deliveredAt Number
classifiedAt Number
classifiedBy String
doneAt Number
doneBy String
processedBy String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ape-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Assessment - Delete

Back to top

Delete an assessment medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

assessment
subtype String

impression, diagnosis
text String
icd10 String
recommendedProcedures Object[]
recommendedProcedures.id String

auto generated array id
recommendedProcedures.ref String
recommendedProcedures.text String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "assessment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Assessment - Find

Back to top

Get assessment medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=assessment" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

assessment
medicalRecords.subtype String

impression, diagnosis
medicalRecords.text String
medicalRecords.icd10 String
medicalRecords.recommendedProcedures Object[]
medicalRecords.recommendedProcedures.id String

auto generated array id
medicalRecords.recommendedProcedures.ref String
medicalRecords.recommendedProcedures.text String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "assessment",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "assessment",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Assessment - Get

Back to top

Get an assessment medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

assessment
subtype String

impression, diagnosis
text String
icd10 String
recommendedProcedures Object[]
recommendedProcedures.id String

auto generated array id
recommendedProcedures.ref String
recommendedProcedures.text String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "assessment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Assessment - Patch

Back to top

Update an assessment medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
text String optional
icd10 String optional
recommendedProcedures Object[] optional
recommendedProcedures.id String Default value: auto generated id
recommendedProcedures.ref String
recommendedProcedures.text String
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "text": "some text",
    "icd10": "some icd10"
  }'

Parameters examples

json - Request-Example

{
  "text": "some text",
  "icd10": "some icd10"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

assessment
subtype String

impression, diagnosis
text String
icd10 String
recommendedProcedures Object[]
recommendedProcedures.id String

auto generated array id
recommendedProcedures.ref String
recommendedProcedures.text String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "assessment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Assessment - Post

Back to top

Create a medical record for assessment

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: "assessment"
subtype String Allowed values: "impression","diagnosis"
text String optional
icd10 String optional
recommendedProcedures Object[] optional
recommendedProcedures.id String Default value: auto generated id
recommendedProcedures.ref String
recommendedProcedures.text String
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "assessment",
    "subtype": "diagnosis",
    "text": "some text",
    "icd10": "some icd10"
  }'

Parameters examples

json - Request-Example

{
  "type": "assessment",
  "subtype": "diagnosis",
  "text": "some text",
  "icd10": "some icd10"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

assessment
subtype String

impression, diagnosis
text String
icd10 String
recommendedProcedures Object[]
recommendedProcedures.id String

auto generated array id
recommendedProcedures.ref String
recommendedProcedures.text String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "assessment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Attachment - Delete

Back to top

Delete an attachment medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

attachment
subtype String
title String
description String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "attachment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Attachment - Find

Back to top

Get attachment medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=attachment" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

attachment
medicalRecords.subtype String
medicalRecords.title String
medicalRecords.description String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "attachment",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "attachment",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Attachment - Get

Back to top

Get an attachment medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

attachment
subtype String
title String
description String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "attachment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Attachment - Patch

Back to top

Update an attachment medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
title String optional
description String optional
name String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "title": "some title",
    "description": "some description"
  }'

Parameters examples

json - Request-Example

{
  "title": "some title",
  "description": "some description"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

attachment
subtype String
title String
description String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "attachment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Attachment - Post

Back to top

Create a medical record for attachment \

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: "attachment"
subtype String optional
title String optional
description String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json"
  -H "Authorization: Bearer <your-api-token>"
  -d '{
    "type": "attachment",
    "title": "some title",
    "description": "some description"
  }'

Parameters examples

json - Request-Example

{
  "type": "attachment",
  "title": "some title",
  "description": "some description"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

attachment
subtype String
title String
description String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "attachment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Audiometry Report - Delete

Back to top

Delete an audiometry report medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

audiometry-report
subtype String
order String

medical-procedure-order reference id
airRightEar Object[]
airRightEar.frequency Number

in hertz (Hz)
airRightEar.hearingLevel Number

in decibels (dB)
airRightEar.audiogramKey String
airLeftEar Object[]
airLeftEar.frequency Number

in hertz (Hz)
airLeftEar.hearingLevel Number

in decibels (dB)
airLeftEar.audiogramKey String
boneRightEar Object[]
boneRightEar.frequency Number

in hertz (Hz)
boneRightEar.hearingLevel Number

in decibels (dB)
boneRightEar.audiogramKey String
boneLeftEar Object[]
boneLeftEar.frequency Number

in hertz (Hz)
boneLeftEar.hearingLevel Number

in decibels (dB)
boneLeftEar.audiogramKey String
boneFF Object[]
boneFF.frequency String

in hertz (Hz)
boneFF.hearingLevel String

in decibels (dB)
boneFF.audiogramKey String
audiogramKeyAirLeftEar String
audiogramKeyAirRightEar String
audiogramKeyBoneLeftEar String
audiogramKeyBoneRightEar String
audiogramKeyBoneFF String
remarks String
ent String

ent doctor's uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "audiometry-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Audiometry Report - Find

Back to top

Get audiometry report medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=audiometry-report" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

audiometry-report
medicalRecords.subtype String
medicalRecords.order String

medical-procedure-order reference id
medicalRecords.airRightEar Object[]
medicalRecords.airRightEar.frequency Number

in hertz (Hz)
medicalRecords.airRightEar.hearingLevel Number

in decibels (dB)
medicalRecords.airRightEar.audiogramKey String
medicalRecords.airLeftEar Object[]
medicalRecords.airLeftEar.frequency Number

in hertz (Hz)
medicalRecords.airLeftEar.hearingLevel Number

in decibels (dB)
medicalRecords.airLeftEar.audiogramKey String
medicalRecords.boneRightEar Object[]
medicalRecords.boneRightEar.frequency Number

in hertz (Hz)
medicalRecords.boneRightEar.hearingLevel Number

in decibels (dB)
medicalRecords.boneRightEar.audiogramKey String
medicalRecords.boneLeftEar Object[]
medicalRecords.boneLeftEar.frequency Number

in hertz (Hz)
medicalRecords.boneLeftEar.hearingLevel Number

in decibels (dB)
medicalRecords.boneLeftEar.audiogramKey String
medicalRecords.boneFF Object[]
medicalRecords.boneFF.frequency String

in hertz (Hz)
medicalRecords.boneFF.hearingLevel String

in decibels (dB)
medicalRecords.boneFF.audiogramKey String
medicalRecords.audiogramKeyAirLeftEar String
medicalRecords.audiogramKeyAirRightEar String
medicalRecords.audiogramKeyBoneLeftEar String
medicalRecords.audiogramKeyBoneRightEar String
medicalRecords.audiogramKeyBoneFF String
medicalRecords.remarks String
medicalRecords.ent String

ent doctor's uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "audiometry-report",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "audiometry-report",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Audiometry Report - Get

Back to top

Get an audiometry report medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

audiometry-report
subtype String
order String

medical-procedure-order reference id
airRightEar Object[]
airRightEar.frequency Number

in hertz (Hz)
airRightEar.hearingLevel Number

in decibels (dB)
airRightEar.audiogramKey String
airLeftEar Object[]
airLeftEar.frequency Number

in hertz (Hz)
airLeftEar.hearingLevel Number

in decibels (dB)
airLeftEar.audiogramKey String
boneRightEar Object[]
boneRightEar.frequency Number

in hertz (Hz)
boneRightEar.hearingLevel Number

in decibels (dB)
boneRightEar.audiogramKey String
boneLeftEar Object[]
boneLeftEar.frequency Number

in hertz (Hz)
boneLeftEar.hearingLevel Number

in decibels (dB)
boneLeftEar.audiogramKey String
boneFF Object[]
boneFF.frequency String

in hertz (Hz)
boneFF.hearingLevel String

in decibels (dB)
boneFF.audiogramKey String
audiogramKeyAirLeftEar String
audiogramKeyAirRightEar String
audiogramKeyBoneLeftEar String
audiogramKeyBoneRightEar String
audiogramKeyBoneFF String
remarks String
ent String

ent doctor's uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "audiometry-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Audiometry Report - Patch

Back to top

Update an audiometry report medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
order String optional

medical-procedure-order reference id
airRightEar Object[] optional
airRightEar.frequency Number

in hertz (Hz)
airRightEar.hearingLevel Number

in decibels (dB)
airRightEar.audiogramKey String
airLeftEar Object[] optional
airLeftEar.frequency Number

in hertz (Hz)
airLeftEar.hearingLevel Number

in decibels (dB)
airLeftEar.audiogramKey String
boneRightEar Object[] optional
boneRightEar.frequency Number

in hertz (Hz)
boneRightEar.hearingLevel Number

in decibels (dB)
boneRightEar.audiogramKey String
boneLeftEar Object[] optional
boneLeftEar.frequency Number

in hertz (Hz)
boneLeftEar.hearingLevel Number

in decibels (dB)
boneLeftEar.audiogramKey String
boneFF Object[] optional
boneFF.frequency String

in hertz (Hz)
boneFF.hearingLevel String

in decibels (dB)
boneFF.audiogramKey String
audiogramKeyAirLeftEar String optional
audiogramKeyAirRightEar String optional
audiogramKeyBoneLeftEar String optional
audiogramKeyBoneRightEar String optional
audiogramKeyBoneFF String optional
remarks String optional
ent String optional

ent doctor's uid
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "order": "order-id",
    "ent": "ent-uid"
  }'

Parameters examples

json - Request-Example

{
  "order": "order-id",
  "ent": "ent-uid"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

audiometry-report
subtype String
order String

medical-procedure-order reference id
airRightEar Object[]
airRightEar.frequency Number

in hertz (Hz)
airRightEar.hearingLevel Number

in decibels (dB)
airRightEar.audiogramKey String
airLeftEar Object[]
airLeftEar.frequency Number

in hertz (Hz)
airLeftEar.hearingLevel Number

in decibels (dB)
airLeftEar.audiogramKey String
boneRightEar Object[]
boneRightEar.frequency Number

in hertz (Hz)
boneRightEar.hearingLevel Number

in decibels (dB)
boneRightEar.audiogramKey String
boneLeftEar Object[]
boneLeftEar.frequency Number

in hertz (Hz)
boneLeftEar.hearingLevel Number

in decibels (dB)
boneLeftEar.audiogramKey String
boneFF Object[]
boneFF.frequency String

in hertz (Hz)
boneFF.hearingLevel String

in decibels (dB)
boneFF.audiogramKey String
audiogramKeyAirLeftEar String
audiogramKeyAirRightEar String
audiogramKeyBoneLeftEar String
audiogramKeyBoneRightEar String
audiogramKeyBoneFF String
remarks String
ent String

ent doctor's uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "audiometry-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Audiometry Report - Post

Back to top

Create a medical record for audiometry report

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: "audiometry-report"
subtype String optional
order String optional

medical-procedure-order reference id
airRightEar Object[] optional
airRightEar.frequency Number

in hertz (Hz)
airRightEar.hearingLevel Number

in decibels (dB)
airRightEar.audiogramKey String
airLeftEar Object[] optional
airLeftEar.frequency Number

in hertz (Hz)
airLeftEar.hearingLevel Number

in decibels (dB)
airLeftEar.audiogramKey String
boneRightEar Object[] optional
boneRightEar.frequency Number

in hertz (Hz)
boneRightEar.hearingLevel Number

in decibels (dB)
boneRightEar.audiogramKey String
boneLeftEar Object[] optional
boneLeftEar.frequency Number

in hertz (Hz)
boneLeftEar.hearingLevel Number

in decibels (dB)
boneLeftEar.audiogramKey String
boneFF Object[] optional
boneFF.frequency String

in hertz (Hz)
boneFF.hearingLevel String

in decibels (dB)
boneFF.audiogramKey String
audiogramKeyAirLeftEar String optional
audiogramKeyAirRightEar String optional
audiogramKeyBoneLeftEar String optional
audiogramKeyBoneRightEar String optional
audiogramKeyBoneFF String optional
remarks String optional
ent String optional

ent doctor's uid
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "audiometry-report",
    "order": "order-id",
    "ent": "ent-uid"
  }'

Parameters examples

json - Request-Example

{
  "type": "audiometry-report",
  "order": "order-id",
  "ent": "ent-uid"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

audiometry-report
subtype String
order String

medical-procedure-order reference id
airRightEar Object[]
airRightEar.frequency Number

in hertz (Hz)
airRightEar.hearingLevel Number

in decibels (dB)
airRightEar.audiogramKey String
airLeftEar Object[]
airLeftEar.frequency Number

in hertz (Hz)
airLeftEar.hearingLevel Number

in decibels (dB)
airLeftEar.audiogramKey String
boneRightEar Object[]
boneRightEar.frequency Number

in hertz (Hz)
boneRightEar.hearingLevel Number

in decibels (dB)
boneRightEar.audiogramKey String
boneLeftEar Object[]
boneLeftEar.frequency Number

in hertz (Hz)
boneLeftEar.hearingLevel Number

in decibels (dB)
boneLeftEar.audiogramKey String
boneFF Object[]
boneFF.frequency String

in hertz (Hz)
boneFF.hearingLevel String

in decibels (dB)
boneFF.audiogramKey String
audiogramKeyAirLeftEar String
audiogramKeyAirRightEar String
audiogramKeyBoneLeftEar String
audiogramKeyBoneRightEar String
audiogramKeyBoneFF String
remarks String
ent String

ent doctor's uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "audiometry-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Birth History - Delete

Back to top

Delete a birth history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

birth-history
subtype String
methodOfDelivery String
attendedBy String
complications String
deliveredAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "birth-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Birth History - Find

Back to top

Get birth history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=birth-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

birth-history
medicalRecords.subtype String
medicalRecords.methodOfDelivery String
medicalRecords.attendedBy String
medicalRecords.complications String
medicalRecords.deliveredAt Number
medicalRecords.notes String
medicalRecords.source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "birth-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "birth-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Birth History - Get

Back to top

Get a birth history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

birth-history
subtype String
methodOfDelivery String
attendedBy String
complications String
deliveredAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "birth-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Birth History - Patch

Back to top

Update a birth history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
methodOfDelivery String optional
attendedBy String optional
complications String optional
deliveredAt Number optional
notes String optional
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "methodOfDelivery": "some methodOfDelivery",
    "complications": "some complications"
  }'

Parameters examples

json - Request-Example

{
  "methodOfDelivery": "some methodOfDelivery",
  "complications": "some complications"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

birth-history
subtype String
methodOfDelivery String
attendedBy String
complications String
deliveredAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "birth-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Birth History - Post

Back to top

Create a medical record for birth history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: "birth-history"
subtype String optional
methodOfDelivery String optional
attendedBy String optional
complications String optional
deliveredAt Number optional
notes String optional
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "birth-history",
    "methodOfDelivery": "some methodOfDelivery",
    "complications": "some complications"
  }'

Parameters examples

json - Request-Example

{
  "type": "birth-history",
  "methodOfDelivery": "some methodOfDelivery",
  "complications": "some complications"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

birth-history
subtype String
methodOfDelivery String
attendedBy String
complications String
deliveredAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "birth-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Dental History - Delete

Back to top

Delete a dental history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

dental-history
subtype String
medicalConditionAt Number
gingivae String
teeth String[]
palate String
frenum String
profile String
hygiene String
abrasions String
recededGums String
mouthOpening String
prevDentist String
prevDentistContactNo String
oropharynx String
teethDiscoloration String
calculus String
tongue String
malocclusion String
mentalis String
swallowing String
gagFlex String
habits String[]
complications String[]
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "dental-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Dental History - Find

Back to top

Get dental history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=dental-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

dental-history
medicalRecords.subtype String
medicalRecords.medicalConditionAt Number
medicalRecords.gingivae String
medicalRecords.teeth String[]
medicalRecords.palate String
medicalRecords.frenum String
medicalRecords.profile String
medicalRecords.hygiene String
medicalRecords.abrasions String
medicalRecords.recededGums String
medicalRecords.mouthOpening String
medicalRecords.prevDentist String
medicalRecords.prevDentistContactNo String
medicalRecords.oropharynx String
medicalRecords.teethDiscoloration String
medicalRecords.calculus String
medicalRecords.tongue String
medicalRecords.malocclusion String
medicalRecords.mentalis String
medicalRecords.swallowing String
medicalRecords.gagFlex String
medicalRecords.habits String[]
medicalRecords.complications String[]
medicalRecords.notes String
medicalRecords.source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "dental-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "dental-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Dental History - Get

Back to top

Get a dental history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

dental-history
subtype String
medicalConditionAt Number
gingivae String
teeth String[]
palate String
frenum String
profile String
hygiene String
abrasions String
recededGums String
mouthOpening String
prevDentist String
prevDentistContactNo String
oropharynx String
teethDiscoloration String
calculus String
tongue String
malocclusion String
mentalis String
swallowing String
gagFlex String
habits String[]
complications String[]
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "dental-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Dental History - Patch

Back to top

Update a dental history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
medicalConditionAt Number optional
gingivae String optional
teeth String[] optional
palate String optional
frenum String optional
profile String optional
hygiene String optional
abrasions String optional
recededGums String optional
mouthOpening String optional
prevDentist String optional
prevDentistContactNo String optional
oropharynx String optional
teethDiscoloration String optional
calculus String optional
tongue String optional
malocclusion String optional
mentalis String optional
swallowing String optional
gagFlex String optional
habits String[] optional
complications String[] optional
notes String optional
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "palate": "some palate",
    "frenum": "some frenum"
  }'

Parameters examples

json - Request-Example

{
  "palate": "some palate",
  "frenum": "some frenum"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

dental-history
subtype String
medicalConditionAt Number
gingivae String
teeth String[]
palate String
frenum String
profile String
hygiene String
abrasions String
recededGums String
mouthOpening String
prevDentist String
prevDentistContactNo String
oropharynx String
teethDiscoloration String
calculus String
tongue String
malocclusion String
mentalis String
swallowing String
gagFlex String
habits String[]
complications String[]
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "dental-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Dental History - Post

Back to top

Create a medical record for dental history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: "dental-history"
subtype String optional
medicalConditionAt Number optional
gingivae String optional
teeth String[] optional
palate String optional
frenum String optional
profile String optional
hygiene String optional
abrasions String optional
recededGums String optional
mouthOpening String optional
prevDentist String optional
prevDentistContactNo String optional
oropharynx String optional
teethDiscoloration String optional
calculus String optional
tongue String optional
malocclusion String optional
mentalis String optional
swallowing String optional
gagFlex String optional
habits String[] optional
complications String[] optional
notes String optional
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "dental-history",
    "palate": "some palate",
    "frenum": "some frenum"
  }'

Parameters examples

json - Request-Example

{
  "type": "dental-history",
  "palate": "some palate",
  "frenum": "some frenum"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

dental-history
subtype String
medicalConditionAt Number
gingivae String
teeth String[]
palate String
frenum String
profile String
hygiene String
abrasions String
recededGums String
mouthOpening String
prevDentist String
prevDentistContactNo String
oropharynx String
teethDiscoloration String
calculus String
tongue String
malocclusion String
mentalis String
swallowing String
gagFlex String
habits String[]
complications String[]
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "dental-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Dental Note - Delete

Back to top

Delete a dental note medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

dental-note
subtype String

baseline, order, result
ageGroup String

adult, mixed, child
teeth String[]
service String

Service#id reference
materials String
cc String
hx String
ss String
dx String
status Object
surfaces Object[]
surfaces.name String
surfaces.icdas String
surfaces.cast String
doneAt Number
doneBy String
order String

DentalNote#id (order) reference
notes String
icd10 String
diagnosisCode String
diagnosisText String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "dental-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Dental Note - Find

Back to top

Get dental note medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=dental-note" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

dental-note
medicalRecords.subtype String

baseline, order, result
medicalRecords.ageGroup String

adult, mixed, child
medicalRecords.teeth String[]
medicalRecords.service String

Service#id reference
medicalRecords.materials String
medicalRecords.cc String
medicalRecords.hx String
medicalRecords.ss String
medicalRecords.dx String
medicalRecords.status Object
medicalRecords.surfaces Object[]
medicalRecords.surfaces.name String
medicalRecords.surfaces.icdas String
medicalRecords.surfaces.cast String
medicalRecords.doneAt Number
medicalRecords.doneBy String
medicalRecords.order String

DentalNote#id (order) reference
medicalRecords.notes String
medicalRecords.icd10 String
medicalRecords.diagnosisCode String
medicalRecords.diagnosisText String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "dental-note",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "dental-note",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Dental Note - Get

Back to top

Get a dental note medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

dental-note
subtype String

baseline, order, result
ageGroup String

adult, mixed, child
teeth String[]
service String

Service#id reference
materials String
cc String
hx String
ss String
dx String
status Object
surfaces Object[]
surfaces.name String
surfaces.icdas String
surfaces.cast String
doneAt Number
doneBy String
order String

DentalNote#id (order) reference
notes String
icd10 String
diagnosisCode String
diagnosisText String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "dental-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Dental Note - Patch

Back to top

Update a dental note medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
ageGroup String optional Allowed values: adult,mixed,child
teeth String[] optional
service String optional

Service#id reference
materials String optional
cc String optional
hx String optional
ss String optional
dx String optional
status Object optional
surfaces Object[] optional
surfaces.name String
surfaces.icdas String
surfaces.cast String
doneAt Number optional
doneBy String optional
order String optional

DentalNote#id (order) reference
notes String optional
icd10 String optional
diagnosisCode String optional
diagnosisText String optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "cc": "some cc",
    "hx": "some hx"
  }'

Parameters examples

json - Request-Example

{
  "cc": "some cc",
  "hx": "some hx"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

dental-note
subtype String

baseline, order, result
ageGroup String

adult, mixed, child
teeth String[]
service String

Service#id reference
materials String
cc String
hx String
ss String
dx String
status Object
surfaces Object[]
surfaces.name String
surfaces.icdas String
surfaces.cast String
doneAt Number
doneBy String
order String

DentalNote#id (order) reference
notes String
icd10 String
diagnosisCode String
diagnosisText String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "dental-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Dental Note - Post

Back to top

Create a medical record for dental note

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: dental-note
subtype String optional Allowed values: baseline,order,result
ageGroup String optional Allowed values: adult,mixed,child
teeth String[] optional
service String optional

Service#id reference
materials String optional
cc String optional
hx String optional
ss String optional
dx String optional
status Object optional
surfaces Object[] optional
surfaces.name String
surfaces.icdas String
surfaces.cast String
doneAt Number optional
doneBy String optional
order String optional

DentalNote#id (order) reference
notes String optional
icd10 String optional
diagnosisCode String optional
diagnosisText String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "dental-note",
    "cc": "some cc",
    "hx": "some hx"
  }'

Parameters examples

json - Request-Example

{
  "type": "dental-note",
  "cc": "some cc",
  "hx": "some hx"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

dental-note
subtype String

baseline, order, result
ageGroup String

adult, mixed, child
teeth String[]
service String

Service#id reference
materials String
cc String
hx String
ss String
dx String
status Object
surfaces Object[]
surfaces.name String
surfaces.icdas String
surfaces.cast String
doneAt Number
doneBy String
order String

DentalNote#id (order) reference
notes String
icd10 String
diagnosisCode String
diagnosisText String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "dental-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Developmental Milestone - Delete

Back to top

Delete a developmental milestone medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

developmental-milestone
subtype String
accomplishedAt Number
category String

grossmotor, adaptivefinemotor, language, personalandsocial
age String
milestone String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "developmental-milestone",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Developmental Milestone - Find

Back to top

Get developmental milestone medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=developmental-milestone" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

developmental-milestone
medicalRecords.subtype String
medicalRecords.accomplishedAt Number
medicalRecords.category String

grossmotor, adaptivefinemotor, language, personalandsocial
medicalRecords.age String
medicalRecords.milestone String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "developmental-milestone",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "developmental-milestone",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Developmental Milestone - Get

Back to top

Get a developmental milestone medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

developmental-milestone
subtype String
accomplishedAt Number
category String

grossmotor, adaptivefinemotor, language, personalandsocial
age String
milestone String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "developmental-milestone",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Developmental Milestone - Patch

Back to top

Update a developmental milestone medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
accomplishedAt Number optional
category String Allowed values: grossmotor,adaptivefinemotor,language,personalandsocial
age String
milestone String
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "category": "grossmotor",
    "age": "23",
    "milestone": "some milestone"
  }'

Parameters examples

json - Request-Example

{
  "category": "grossmotor",
  "age": "23",
  "milestone": "some milestone"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

developmental-milestone
subtype String
accomplishedAt Number
category String

grossmotor, adaptivefinemotor, language, personalandsocial
age String
milestone String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "developmental-milestone",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Developmental Milestone - Post

Back to top

Create a medical record for developmental milestone

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: developmental-milestone
subtype String optional
accomplishedAt Number optional
category String Allowed values: grossmotor,adaptivefinemotor,language,personalandsocial
age String
milestone String
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "developmental-milestone",
    "category": "grossmotor",
    "age": "23",
    "milestone": "some milestone"
  }'

Parameters examples

json - Request-Example

{
  "type": "developmental-milestone",
  "category": "grossmotor",
  "age": "23",
  "milestone": "some milestone"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

developmental-milestone
subtype String
accomplishedAt Number
category String

grossmotor, adaptivefinemotor, language, personalandsocial
age String
milestone String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "developmental-milestone",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Discharge Note - Delete

Back to top

Delete a discharge note medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

discharge-note
subtype String
diagnosis String
instructions String
disposition String

where px will go after discharge. e.g. home, sis's home
residents String[]

name or id
interns String[]

name or id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "discharge-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Discharge Note - Find

Back to top

Get discharge note medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=discharge-note" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

discharge-note
medicalRecords.subtype String
medicalRecords.diagnosis String
medicalRecords.instructions String
medicalRecords.disposition String

where px will go after discharge. e.g. home, sis's home
medicalRecords.residents String[]

name or id
medicalRecords.interns String[]

name or id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "discharge-note",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "discharge-note",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Discharge Note - Get

Back to top

Get a discharge note medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

discharge-note
subtype String
diagnosis String
instructions String
disposition String

where px will go after discharge. e.g. home, sis's home
residents String[]

name or id
interns String[]

name or id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "discharge-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Discharge Note - Patch

Back to top

Update a discharge note medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
diagnosis String optional
instructions String optional
disposition String optional

where px will go after discharge. e.g. home, sis's home
residents String[] optional

name or id
interns String[] optional

name or id
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "diagnosis": "some diagnosis",
    "instructions": "some instructions"
  }'

Parameters examples

json - Request-Example

{
  "diagnosis": "some diagnosis",
  "instructions": "some instructions"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

discharge-note
subtype String
diagnosis String
instructions String
disposition String

where px will go after discharge. e.g. home, sis's home
residents String[]

name or id
interns String[]

name or id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "discharge-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Discharge Note - Post

Back to top

Create a medical record for discharge note

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: discharge-note
subtype String optional
diagnosis String optional
instructions String optional
disposition String optional

where px will go after discharge. e.g. home, sis's home
residents String[] optional

name or id
interns String[] optional

name or id
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "discharge-note",
    "diagnosis": "some diagnosis",
    "instructions": "some instructions"
  }'

Parameters examples

json - Request-Example

{
  "type": "discharge-note",
  "diagnosis": "some diagnosis",
  "instructions": "some instructions"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

discharge-note
subtype String
diagnosis String
instructions String
disposition String

where px will go after discharge. e.g. home, sis's home
residents String[]

name or id
interns String[]

name or id

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "discharge-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

ENT Note - Delete

Back to top

Delete an ent note medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ent-note
subtype String
cpapPressure Number
lsatPressure Number
bipapInspiration Number
bipapExpiration Number
ahi Number
rampTime Number
psgDiagnostic String
psgTherapeutic String
psgSplit String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ent-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

ENT Note - Find

Back to top

Get ent note medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=ent-note" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

ent-note
medicalRecords.subtype String
medicalRecords.cpapPressure Number
medicalRecords.lsatPressure Number
medicalRecords.bipapInspiration Number
medicalRecords.bipapExpiration Number
medicalRecords.ahi Number
medicalRecords.rampTime Number
medicalRecords.psgDiagnostic String
medicalRecords.psgTherapeutic String
medicalRecords.psgSplit String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "ent-note",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "ent-note",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

ENT Note - Get

Back to top

Get an ent note medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ent-note
subtype String
cpapPressure Number
lsatPressure Number
bipapInspiration Number
bipapExpiration Number
ahi Number
rampTime Number
psgDiagnostic String
psgTherapeutic String
psgSplit String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ent-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

ENT Note - Patch

Back to top

Update an ent note medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
cpapPressure Number optional
lsatPressure Number optional
bipapInspiration Number optional
bipapExpiration Number optional
ahi Number optional
rampTime Number optional
psgDiagnostic String optional
psgTherapeutic String optional
psgSplit String optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "cpapPressure": 10,
    "lsatPressure": 20
  }'

Parameters examples

json - Request-Example

{
  "cpapPressure": 10,
  "lsatPressure": 20
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ent-note
subtype String
cpapPressure Number
lsatPressure Number
bipapInspiration Number
bipapExpiration Number
ahi Number
rampTime Number
psgDiagnostic String
psgTherapeutic String
psgSplit String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ent-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

ENT Note - Post

Back to top

Create a medical record for ent note

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: ent-note
subtype String optional
cpapPressure Number optional
lsatPressure Number optional
bipapInspiration Number optional
bipapExpiration Number optional
ahi Number optional
rampTime Number optional
psgDiagnostic String optional
psgTherapeutic String optional
psgSplit String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "ent-note",
    "cpapPressure": 10,
    "lsatPressure": 20
  }'

Parameters examples

json - Request-Example

{
  "type": "ent-note",
  "cpapPressure": 10,
  "lsatPressure": 20
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ent-note
subtype String
cpapPressure Number
lsatPressure Number
bipapInspiration Number
bipapExpiration Number
ahi Number
rampTime Number
psgDiagnostic String
psgTherapeutic String
psgSplit String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ent-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Family History - Delete

Back to top

Delete a family history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

family-history
subtype String
medicalCondition String
medicalConditionAt Number
relationship String

mother, father, brother, sister, etc...
deceased Boolean
deathCause String

disease/cause of death
source String

who provided the details
notes String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "family-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Family History - Find

Back to top

Get family history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=family-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

family-history
medicalRecords.subtype String
medicalRecords.medicalCondition String
medicalRecords.medicalConditionAt Number
medicalRecords.relationship String

mother, father, brother, sister, etc...
medicalRecords.deceased Boolean
medicalRecords.deathCause String

disease/cause of death
medicalRecords.source String

who provided the details
medicalRecords.notes String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "family-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "family-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Family History - Get

Back to top

Get a family history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

family-history
subtype String
medicalCondition String
medicalConditionAt Number
relationship String

mother, father, brother, sister, etc...
deceased Boolean
deathCause String

disease/cause of death
source String

who provided the details
notes String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "family-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Family History - Patch

Back to top

Update a family history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
medicalCondition String optional
medicalConditionAt Number optional
relationship String optional

mother, father, brother, sister, etc...
deceased Boolean optional
deathCause String optional

disease/cause of death
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "medicalCondition": "some medicalCondition",
    "deathCause": "some deathCause"
  }'

Parameters examples

json - Request-Example

{
  "medicalCondition": "some medicalCondition",
  "deathCause": "some deathCause"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

family-history
subtype String
medicalCondition String
medicalConditionAt Number
relationship String

mother, father, brother, sister, etc...
deceased Boolean
deathCause String

disease/cause of death
source String

who provided the details
notes String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "family-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Family History - Post

Back to top

Create a medical record for family history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: family-history
subtype String optional
medicalCondition String optional
medicalConditionAt Number optional
relationship String optional

mother, father, brother, sister, etc...
deceased Boolean optional
deathCause String optional

disease/cause of death
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "family-history",
    "medicalCondition": "some medicalCondition",
    "deathCause": "some deathCause"
  }'

Parameters examples

json - Request-Example

{
  "type": "family-history",
  "medicalCondition": "some medicalCondition",
  "deathCause": "some deathCause"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

family-history
subtype String
medicalCondition String
medicalConditionAt Number
relationship String

mother, father, brother, sister, etc...
deceased Boolean
deathCause String

disease/cause of death
source String

who provided the details
notes String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "family-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Gynecological History - Delete

Back to top

Delete a gynecological history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

gynecological-history
subtype String
prevCervicSmearsDate Number
prevCervicSmearsResult String
prevProblemsTreatments String
currentContraception String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "gynecological-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Gynecological History - Find

Back to top

Get gynecological history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=gynecological-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

gynecological-history
medicalRecords.subtype String
medicalRecords.prevCervicSmearsDate Number
medicalRecords.prevCervicSmearsResult String
medicalRecords.prevProblemsTreatments String
medicalRecords.currentContraception String
medicalRecords.notes String
medicalRecords.source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "gynecological-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "gynecological-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Gynecological History - Get

Back to top

Get a gynecological history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

gynecological-history
subtype String
prevCervicSmearsDate Number
prevCervicSmearsResult String
prevProblemsTreatments String
currentContraception String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "gynecological-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Gynecological History - Patch

Back to top

Update a gynecological history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
prevCervicSmearsDate Number optional
prevCervicSmearsResult String optional
prevProblemsTreatments String optional
currentContraception String optional
notes String optional
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

gynecological-history
subtype String
prevCervicSmearsDate Number
prevCervicSmearsResult String
prevProblemsTreatments String
currentContraception String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "gynecological-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Gynecological History - Post

Back to top

Create a medical record for gynecological history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: gynecological-history
subtype String optional
prevCervicSmearsDate Number optional
prevCervicSmearsResult String optional
prevProblemsTreatments String optional
currentContraception String optional
notes String optional
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "gynecological-history",
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "type": "gynecological-history",
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

gynecological-history
subtype String
prevCervicSmearsDate Number
prevCervicSmearsResult String
prevProblemsTreatments String
currentContraception String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "gynecological-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Hospitalization History - Delete

Back to top

Delete a hospitalization history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

hospitalization-history
subtype String
hospitalizedAt Number
hospitalName String
diagnosis String
treatment String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "hospitalization-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Hospitalization History - Find

Back to top

Get hospitalization history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=hospitalization-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

hospitalization-history
medicalRecords.subtype String
medicalRecords.hospitalizedAt Number
medicalRecords.hospitalName String
medicalRecords.diagnosis String
medicalRecords.treatment String
medicalRecords.notes String
medicalRecords.source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "hospitalization-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "hospitalization-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Hospitalization History - Get

Back to top

Get a hospitalization history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

hospitalization-history
subtype String
hospitalizedAt Number
hospitalName String
diagnosis String
treatment String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "hospitalization-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Hospitalization History - Patch

Back to top

Update a hospitalization history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
hospitalizedAt Number optional
hospitalName String optional
diagnosis String optional
treatment String optional
notes String optional
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

hospitalization-history
subtype String
hospitalizedAt Number
hospitalName String
diagnosis String
treatment String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "hospitalization-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Hospitalization History - Post

Back to top

Create a medical record for hospitalization history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: hospitalization-history
subtype String optional
hospitalizedAt Number optional
hospitalName String optional
diagnosis String optional
treatment String optional
notes String optional
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "hospitalization-history",
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "type": "hospitalization-history",
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

hospitalization-history
subtype String
hospitalizedAt Number
hospitalName String
diagnosis String
treatment String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "hospitalization-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Hypertension History - Delete

Back to top

Delete a hypertension history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

hypertension-history
subtype String
usualBP String
highestBP String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "hypertension-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Hypertension History - Find

Back to top

Get hypertension history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=hypertension-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

hypertension-history
medicalRecords.subtype String
medicalRecords.usualBP String
medicalRecords.highestBP String
medicalRecords.notes String
medicalRecords.source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "hypertension-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "hypertension-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Hypertension History - Get

Back to top

Get a hypertension history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

hypertension-history
subtype String
usualBP String
highestBP String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "hypertension-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Hypertension History - Patch

Back to top

Update a hypertension history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
usualBP String optional
highestBP String optional
notes String optional
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

hypertension-history
subtype String
usualBP String
highestBP String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "hypertension-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Hypertension History - Post

Back to top

Create a medical record for hypertension history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: hypertension-history
subtype String optional
usualBP String optional
highestBP String optional
notes String optional
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "hypertension-history",
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "type": "hypertension-history",
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

hypertension-history
subtype String
usualBP String
highestBP String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "hypertension-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Certificate - Delete

Back to top

Delete a medical certificate medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

med-certificate, fit-certificate, health-history, waiver, general, claims
subtype String
order String
template String
data Object
values Object[]
values.id String

form input id
values.answer Any
values.answers Any[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-certificate",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Certificate - Find

Back to top

Get medical certificate medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=<med-certificate, fit-certificate, health-history, waiver, general, claims>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

med-certificate, fit-certificate, health-history, waiver, general, claims
medicalRecords.subtype String
medicalRecords.order String
medicalRecords.template String
medicalRecords.data Object
medicalRecords.values Object[]
medicalRecords.values.id String

form input id
medicalRecords.values.answer Any
medicalRecords.values.answers Any[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "medical-certificate",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "medical-certificate",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Medical Certificate - Get

Back to top

Get a medical certificate medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

med-certificate, fit-certificate, health-history, waiver, general, claims
subtype String
order String
template String
data Object
values Object[]
values.id String

form input id
values.answer Any
values.answers Any[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-certificate",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Certificate - Patch

Back to top

Update a medical certificate medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
order String optional
template String optional
data Object optional
values Object[] optional
values.id String

form input id
values.answer Any
values.answers Any[]
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "template": "some template"
  }'

Parameters examples

json - Request-Example

{
  "template": "some template"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

med-certificate, fit-certificate, health-history, waiver, general, claims
subtype String
order String
template String
data Object
values Object[]
values.id String

form input id
values.answer Any
values.answers Any[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-certificate",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Certificate - Post

Back to top

Create a medical record for medical certificate

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: med-certificate,fit-certificate,health-history,waiver,general,claims
order String optional
template String optional
data Object optional
values Object[] optional
values.id String

form input id
values.answer Any
values.answers Any[]
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "medical-certificate",
    "template": "some template"
  }'

Parameters examples

json - Request-Example

{
  "type": "medical-certificate",
  "template": "some template"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

med-certificate, fit-certificate, health-history, waiver, general, claims
subtype String
order String
template String
data Object
values Object[]
values.id String

form input id
values.answer Any
values.answers Any[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-certificate",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical History - Delete

Back to top

Delete a medical history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-history
subtype String
medicalCondition String
medicalConditionAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical History - Find

Back to top

Get medical history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=medical-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

medical-history
medicalRecords.subtype String
medicalRecords.medicalCondition String
medicalRecords.medicalConditionAt Number
medicalRecords.notes String
medicalRecords.source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "medical-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "medical-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Medical History - Get

Back to top

Get a medical history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-history
subtype String
medicalCondition String
medicalConditionAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical History - Patch

Back to top

Update a medical history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
medicalCondition String optional
medicalConditionAt Number optional
notes String optional
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-history
subtype String
medicalCondition String
medicalConditionAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical History - Post

Back to top

Create a medical record for medical history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: medical-history
subtype String optional
medicalCondition String optional
medicalConditionAt Number optional
notes String optional
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "medical-history",
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "type": "medical-history",
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-history
subtype String
medicalCondition String
medicalConditionAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Note - Delete

Back to top

Delete a medical note medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-note, chief-complaint, hpi, care-plan, spirometry
subtype String
order String

medical-procedure-order reference id
text String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Note - Find

Back to top

Get medical note medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=<medical-note, chief-complaint, hpi, care-plan, spirometry>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

medical-note, chief-complaint, hpi, care-plan, spirometry
medicalRecords.subtype String
medicalRecords.order String

medical-procedure-order reference id
medicalRecords.text String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "medical-note",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "medical-note",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Medical Note - Get

Back to top

Get a medical note medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-note, chief-complaint, hpi, care-plan, spirometry
subtype String
order String

medical-procedure-order reference id
text String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Note - Patch

Back to top

Update a medical note medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
order String optional

medical-procedure-order reference id
text String optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "order": "order-reference-id",
    "text": "some text"
  }'

Parameters examples

json - Request-Example

{
  "order": "order-reference-id",
  "text": "some text"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-note, chief-complaint, hpi, care-plan, spirometry
subtype String
order String

medical-procedure-order reference id
text String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Note - Post

Back to top

Create a medical record for medical note

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: medical-note,chief-complaint,hpi,care-plan,spirometry
subtype String optional
order String optional

medical-procedure-order reference id
text String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "medical-note",
    "order": "order-reference-id",
    "text": "some text"
  }'

Parameters examples

json - Request-Example

{
  "type": "medical-note",
  "order": "order-reference-id",
  "text": "some text"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-note, chief-complaint, hpi, care-plan, spirometry
subtype String
order String

medical-procedure-order reference id
text String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Procedure - Delete

Back to top

Delete a medication order medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-procedure
subtype String
order String

medical procedure order reference id
name String

name of procedure
location String

where was the procedure performed (can be room number)
notes String
ref String
icd10 String
providers String[]

who performed the procedure
linkedRecords String[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-procedure",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Procedure - Find

Back to top

Get medication order medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=medical-procedure" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

medical-procedure
medicalRecords.subtype String
medicalRecords.order String

medical procedure order reference id
medicalRecords.name String

name of procedure
medicalRecords.location String

where was the procedure performed (can be room number)
medicalRecords.notes String
medicalRecords.ref String
medicalRecords.icd10 String
medicalRecords.providers String[]

who performed the procedure
medicalRecords.linkedRecords String[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "medical-procedure",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "medical-procedure",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Medical Procedure - Get

Back to top

Get a medication order medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-procedure
subtype String
order String

medical procedure order reference id
name String

name of procedure
location String

where was the procedure performed (can be room number)
notes String
ref String
icd10 String
providers String[]

who performed the procedure
linkedRecords String[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-procedure",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Procedure - Patch

Back to top

Update a medication order medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
order String optional

medical procedure order reference id
name String optional

name of procedure
location String optional

where was the procedure performed (can be room number)
notes String optional
ref String optional
icd10 String optional
providers String[] optional

who performed the procedure
linkedRecords String[] optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "notes": "some notes"
  }'

Parameters examples

json - Request-Example

{
  "notes": "some notes"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-procedure
subtype String
order String

medical procedure order reference id
name String

name of procedure
location String

where was the procedure performed (can be room number)
notes String
ref String
icd10 String
providers String[]

who performed the procedure
linkedRecords String[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-procedure",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Procedure - Post

Back to top

Create a medical record for medication order

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: medical-procedure
subtype String optional
order String optional

medical procedure order reference id
name String optional

name of procedure
location String optional

where was the procedure performed (can be room number)
notes String optional
ref String optional
icd10 String optional
providers String[] optional

who performed the procedure
linkedRecords String[] optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "medical-procedure",
    "notes": "some notes"
  }'

Parameters examples

json - Request-Example

{
  "type": "medical-procedure",
  "notes": "some notes"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-procedure
subtype String
order String

medical procedure order reference id
name String

name of procedure
location String

where was the procedure performed (can be room number)
notes String
ref String
icd10 String
providers String[]

who performed the procedure
linkedRecords String[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-procedure",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Procedure Order - Delete

Back to top

Delete a medical procedure order medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-procedure-order
subtype String
doneAt Number
doneBy String
name String

name of procedure
service String

service#id reference
serviceName String
serviceType String
serviceSubtype String
reason String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-procedure-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Procedure Order - Find

Back to top

Get medical procedure order medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=medical-procedure-order" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

medical-procedure-order
medicalRecords.subtype String
medicalRecords.doneAt Number
medicalRecords.doneBy String
medicalRecords.name String

name of procedure
medicalRecords.service String

service#id reference
medicalRecords.serviceName String
medicalRecords.serviceType String
medicalRecords.serviceSubtype String
medicalRecords.reason String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "medical-procedure-order",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "medical-procedure-order",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Medical Procedure Order - Get

Back to top

Get a medical procedure order medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-procedure-order
subtype String
doneAt Number
doneBy String
name String

name of procedure
service String

service#id reference
serviceName String
serviceType String
serviceSubtype String
reason String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-procedure-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Procedure Order - Patch

Back to top

Update a medical procedure order medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
doneAt Number optional
doneBy String optional
name String optional

name of procedure
service String optional

service#id reference
serviceName String optional
serviceType String optional
serviceSubtype String optional
reason String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "name": "some name of procedure",
    "service": "some service id"
  }'

Parameters examples

json - Request-Example

{
  "name": "some name of procedure",
  "service": "some service id"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-procedure-order
subtype String
doneAt Number
doneBy String
name String

name of procedure
service String

service#id reference
serviceName String
serviceType String
serviceSubtype String
reason String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-procedure-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Procedure Order - Post

Back to top

Create a medical record for medical procedure order

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: medical-procedure-order
subtype String optional
doneAt Number optional
doneBy String optional
name String optional

name of procedure
service String optional

service#id reference
serviceName String optional
serviceType String optional
serviceSubtype String optional
reason String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "medical-procedure-order",
    "name": "some name of procedure",
    "service": "some service id"
  }'

Parameters examples

json - Request-Example

{
  "type": "medical-procedure-order",
  "name": "some name of procedure",
  "service": "some service id"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medical-procedure-order
subtype String
doneAt Number
doneBy String
name String

name of procedure
service String

service#id reference
serviceName String
serviceType String
serviceSubtype String
reason String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medical-procedure-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Test Order - Delete

Back to top

Delete a medication order medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

lab-test-order, imaging-test-order
subtype String
reason String
tests Object[]
tests.id String
tests.name String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "lab-test-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Test Order - Find

Back to top

Get medication order medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=<lab-test-order, imaging-test-order>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

lab-test-order, imaging-test-order
medicalRecords.subtype String
medicalRecords.reason String
medicalRecords.tests Object[]
medicalRecords.tests.id String
medicalRecords.tests.name String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "lab-test-order",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "lab-test-order",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Medical Test Order - Get

Back to top

Get a medication order medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

lab-test-order, imaging-test-order
subtype String
reason String
tests Object[]
tests.id String
tests.name String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "lab-test-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Test Order - Patch

Back to top

Update a medication order medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
reason String optional
tests Object[] optional
tests.id String
tests.name String
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "reason": "some reason"
  }'

Parameters examples

json - Request-Example

{
  "reason": "some reason"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

lab-test-order, imaging-test-order
subtype String
reason String
tests Object[]
tests.id String
tests.name String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "lab-test-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Test Order - Post

Back to top

Create a medical record for medication order

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: lab-test-order,imaging-test-order
subtype String optional
reason String optional
tests Object[] optional
tests.id String
tests.name String
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "lab-test-order",
    "reason": "some reason"
  }'

Parameters examples

json - Request-Example

{
  "type": "lab-test-order",
  "reason": "some reason"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

lab-test-order, imaging-test-order
subtype String
reason String
tests Object[]
tests.id String
tests.name String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "lab-test-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Test Result - Delete

Back to top

Delete a medication order medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id String

id of medical record

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

lab-test-result, imaging-test-result
subtype String
order String

med test order id
results Object[]
printTemplateValue String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "lab-test-result",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Test Result - Find

Back to top

Get medication order medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=<lab-test-result, imaging-test-result>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

lab-test-result, imaging-test-result
medicalRecords.subtype String
medicalRecords.order String

med test order id
medicalRecords.results Object[]
medicalRecords.printTemplateValue String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "lab-test-result",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "lab-test-result",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Medical Test Result - Get

Back to top

Get a medication order medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id String

id of medical record

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

lab-test-result, imaging-test-result
subtype String
order String

med test order id
results Object[]
printTemplateValue String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "lab-test-result",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Test Result - Patch

Back to top

Update a medication order medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
order String optional

med test order id
results Object[] optional
printTemplateValue String optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "printTemplateValue": "some printTemplateValue"
  }'

Parameters examples

json - Request-Example

{
  "printTemplateValue": "some printTemplateValue"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

lab-test-result, imaging-test-result
subtype String
order String

med test order id
results Object[]
printTemplateValue String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "lab-test-result",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medical Test Result - Post

Back to top

Create a medical record for medication order

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: lab-test-result,imaging-test-result
subtype String optional
order String optional

med test order id
results Object[] optional
printTemplateValue String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "lab-test-result",
    "printTemplateValue": "some printTemplateValue"
  }'

Parameters examples

json - Request-Example

{
  "type": "lab-test-result",
  "printTemplateValue": "some printTemplateValue"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

lab-test-result, imaging-test-result
subtype String
order String

med test order id
results Object[]
printTemplateValue String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "lab-test-result",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medication Order - Delete

Back to top

Delete a medication order medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medication-order
subtype String
note String
items Object[]
items.id String

internal id
items.medicine String

medicine reference id
items.brandName String
items.genericName String
items.drugType String
items.beforeFood String
items.afterFood String
items.morning String
items.afternoon String
items.night String
items.duration Number
items.durationUnit String
items.dispense String
items.dosageSig String
items.dosageAmount Number
items.formulation String
items.formulationClassification String
items.formulationForm String
items.frequency String
items.frequencyReminderInterval Number
items.note String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medication-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medication Order - Find

Back to top

Get medication order medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=medication-order" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

medication-order
medicalRecords.subtype String
medicalRecords.note String
medicalRecords.items Object[]
medicalRecords.items.id String

internal id
medicalRecords.items.medicine String

medicine reference id
medicalRecords.items.brandName String
medicalRecords.items.genericName String
medicalRecords.items.drugType String
medicalRecords.items.beforeFood String
medicalRecords.items.afterFood String
medicalRecords.items.morning String
medicalRecords.items.afternoon String
medicalRecords.items.night String
medicalRecords.items.duration Number
medicalRecords.items.durationUnit String
medicalRecords.items.dispense String
medicalRecords.items.dosageSig String
medicalRecords.items.dosageAmount Number
medicalRecords.items.formulation String
medicalRecords.items.formulationClassification String
medicalRecords.items.formulationForm String
medicalRecords.items.frequency String
medicalRecords.items.frequencyReminderInterval Number
medicalRecords.items.note String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "medication-order",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "medication-order",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Medication Order - Get

Back to top

Get a medication order medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medication-order
subtype String
note String
items Object[]
items.id String

internal id
items.medicine String

medicine reference id
items.brandName String
items.genericName String
items.drugType String
items.beforeFood String
items.afterFood String
items.morning String
items.afternoon String
items.night String
items.duration Number
items.durationUnit String
items.dispense String
items.dosageSig String
items.dosageAmount Number
items.formulation String
items.formulationClassification String
items.formulationForm String
items.frequency String
items.frequencyReminderInterval Number
items.note String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medication-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medication Order - Patch

Back to top

Update a medication order medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
note String optional
items Object[] optional
items.medicine String

medicine reference id

Default value: auto-generated id
items.brandName String
items.genericName String
items.drugType String
items.beforeFood String
items.afterFood String
items.morning String
items.afternoon String
items.night String
items.duration Number
items.durationUnit String
items.dispense String
items.dosageSig String
items.dosageAmount Number
items.formulation String
items.formulationClassification String
items.formulationForm String
items.frequency String
items.frequencyReminderInterval Number
items.note String
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "note": "some note"
  }'

Parameters examples

json - Request-Example

{
  "note": "some note"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medication-order
subtype String
note String
items Object[]
items.id String

internal id
items.medicine String

medicine reference id
items.brandName String
items.genericName String
items.drugType String
items.beforeFood String
items.afterFood String
items.morning String
items.afternoon String
items.night String
items.duration Number
items.durationUnit String
items.dispense String
items.dosageSig String
items.dosageAmount Number
items.formulation String
items.formulationClassification String
items.formulationForm String
items.frequency String
items.frequencyReminderInterval Number
items.note String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medication-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Medication Order - Post

Back to top

Create a medical record for medication order

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: medication-order
subtype String optional
note String optional
items Object[] optional
items.medicine String

medicine reference id

Default value: auto-generated id
items.brandName String
items.genericName String
items.drugType String
items.beforeFood String
items.afterFood String
items.morning String
items.afternoon String
items.night String
items.duration Number
items.durationUnit String
items.dispense String
items.dosageSig String
items.dosageAmount Number
items.formulation String
items.formulationClassification String
items.formulationForm String
items.frequency String
items.frequencyReminderInterval Number
items.note String
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "medication-order",
    "note": "some note"
  }'

Parameters examples

json - Request-Example

{
  "type": "medication-order",
  "note": "some note"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

medication-order
subtype String
note String
items Object[]
items.id String

internal id
items.medicine String

medicine reference id
items.brandName String
items.genericName String
items.drugType String
items.beforeFood String
items.afterFood String
items.morning String
items.afternoon String
items.night String
items.duration Number
items.durationUnit String
items.dispense String
items.dosageSig String
items.dosageAmount Number
items.formulation String
items.formulationClassification String
items.formulationForm String
items.frequency String
items.frequencyReminderInterval Number
items.note String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "medication-order",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Menstrual History - Delete

Back to top

Delete a menstrual history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

menstrual-history
subtype String
menarche String
interval String
duration Number
amount Number
notes String
source String

who provided the details
LMP String
LMPDate Number
cycle String
OBScore String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "menstrual-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Menstrual History - Find

Back to top

Get menstrual history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=menstrual-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

menstrual-history
medicalRecords.subtype String
medicalRecords.menarche String
medicalRecords.interval String
medicalRecords.duration Number
medicalRecords.amount Number
medicalRecords.notes String
medicalRecords.source String

who provided the details
medicalRecords.LMP String
medicalRecords.LMPDate Number
medicalRecords.cycle String
medicalRecords.OBScore String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
   "id": "medical-record-id",
    "type": "menstrual-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
   "id": "medical-record-id",
    "type": "menstrual-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Menstrual History - Get

Back to top

Get a menstrual history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

menstrual-history
subtype String
menarche String
interval String
duration Number
amount Number
notes String
source String

who provided the details
LMP String
LMPDate Number
cycle String
OBScore String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "menstrual-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Menstrual History - Patch

Back to top

Update a menstrual history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
menarche String optional
interval String optional
duration Number optional
amount Number optional
notes String optional
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
LMP String optional
LMPDate Number optional
cycle String optional
OBScore String optional
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

menstrual-history
subtype String
menarche String
interval String
duration Number
amount Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "menstrual-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Menstrual History - Post

Back to top

Create a medical record for menstrual history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: menstrual-history
subtype String optional
menarche String optional
interval String optional
duration Number optional
amount Number optional
notes String optional
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "menstrual-history",
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "type": "menstrual-history",
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
LMP String optional
LMPDate Number optional
cycle String optional
OBScore String optional
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

menstrual-history
subtype String
menarche String
interval String
duration Number
amount Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "menstrual-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Nutritional Assessment - Delete

Back to top

Delete a nutritional assessment medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

nutritional-assessment
subtype String
foodLikes String
foodDislikes String
foodAllergies String
nutritionalSupplements String
appetite String
foodFrequencyMap Object
foodFrequencyMap.redMeat Object
foodFrequencyMap.redMeat.unit String

week, day
foodFrequencyMap.redMeat.min Number
foodFrequencyMap.redMeat.max Number
foodFrequencyMap.whiteMeat Object
foodFrequencyMap.whiteMeat.unit String

week, day
foodFrequencyMap.whiteMeat.min Number
foodFrequencyMap.whiteMeat.max Number
foodFrequencyMap.processedMeat Object
foodFrequencyMap.processedMeat.unit String

week, day
foodFrequencyMap.processedMeat.min Number
foodFrequencyMap.processedMeat.max Number
foodFrequencyMap.beansAndPeasOrLentils Object
foodFrequencyMap.beansAndPeasOrLentils.unit String

week, day
foodFrequencyMap.beansAndPeasOrLentils.min Number
foodFrequencyMap.beansAndPeasOrLentils.max Number
foodFrequencyMap.egg Object
foodFrequencyMap.egg.unit String

week, day
foodFrequencyMap.egg.min Number
foodFrequencyMap.egg.max Number
foodFrequencyMap.milk Object
foodFrequencyMap.milk.unit String

week, day
foodFrequencyMap.milk.min Number
foodFrequencyMap.milk.max Number
foodFrequencyMap.cheeseAndYoghurt Object
foodFrequencyMap.cheeseAndYoghurt.unit String

week, day
foodFrequencyMap.cheeseAndYoghurt.min Number
foodFrequencyMap.cheeseAndYoghurt.max Number
foodFrequencyMap.ricePastaAndBread Object
foodFrequencyMap.ricePastaAndBread.unit String

week, day
foodFrequencyMap.ricePastaAndBread.min Number
foodFrequencyMap.ricePastaAndBread.max Number
foodFrequencyMap.ricePastaAndBreadWholeGrain Object
foodFrequencyMap.ricePastaAndBreadWholeGrain.unit String

week, day
foodFrequencyMap.ricePastaAndBreadWholeGrain.min Number
foodFrequencyMap.ricePastaAndBreadWholeGrain.max Number
foodFrequencyMap.fruit Object
foodFrequencyMap.fruit.unit String

week, day
foodFrequencyMap.fruit.min Number
foodFrequencyMap.fruit.max Number
foodFrequencyMap.vegetable Object
foodFrequencyMap.vegetable.unit String

week, day
foodFrequencyMap.vegetable.min Number
foodFrequencyMap.vegetable.max Number
foodFrequencyMap.water Object
foodFrequencyMap.water.unit String

week, day
foodFrequencyMap.water.min Number
foodFrequencyMap.water.max Number
foodFrequencyMap.alcoholicBeverages Object
foodFrequencyMap.alcoholicBeverages.unit String

week, day
foodFrequencyMap.alcoholicBeverages.min Number
foodFrequencyMap.alcoholicBeverages.max Number
foodFrequencyMap.coffeeAndTea Object
foodFrequencyMap.coffeeAndTea.unit String

week, day
foodFrequencyMap.coffeeAndTea.min Number
foodFrequencyMap.coffeeAndTea.max Number
foodFrequencyMap.fastFood Object
foodFrequencyMap.fastFood.unit String

week, day
foodFrequencyMap.fastFood.min Number
foodFrequencyMap.fastFood.max Number
foodRecallMap Object
foodRecallMap.breakfast String
foodRecallMap.breakfast.time Number
foodRecallMap.breakfast.foods String[]
foodRecallMap.snackAM String
foodRecallMap.snackAM.time Number
foodRecallMap.snackAM.foods String[]
foodRecallMap.lunch String
foodRecallMap.lunch.time Number
foodRecallMap.lunch.foods String[]
foodRecallMap.snackPM String
foodRecallMap.snackPM.time Number
foodRecallMap.snackPM.foods String[]
foodRecallMap.dinner String
foodRecallMap.dinner.time Number
foodRecallMap.dinner.foods String[]
foodRecallMap.snackBeforeBed String
foodRecallMap.snackBeforeBed.time Number
foodRecallMap.snackBeforeBed.foods String[]
nutritionalAssessment String
dietRX String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "nutritional-assessment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Nutritional Assessment - Find

Back to top

Get nutritional assessment medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=nutritional-assessment" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

nutritional-assessment
medicalRecords.subtype String
medicalRecords.foodLikes String
medicalRecords.foodDislikes String
medicalRecords.foodAllergies String
medicalRecords.nutritionalSupplements String
medicalRecords.appetite String
medicalRecords.foodFrequencyMap Object
medicalRecords.foodFrequencyMap.redMeat Object
medicalRecords.foodFrequencyMap.redMeat.unit String

week, day
medicalRecords.foodFrequencyMap.redMeat.min Number
medicalRecords.foodFrequencyMap.redMeat.max Number
medicalRecords.foodFrequencyMap.whiteMeat Object
medicalRecords.foodFrequencyMap.whiteMeat.unit String

week, day
medicalRecords.foodFrequencyMap.whiteMeat.min Number
medicalRecords.foodFrequencyMap.whiteMeat.max Number
medicalRecords.foodFrequencyMap.processedMeat Object
medicalRecords.foodFrequencyMap.processedMeat.unit String

week, day
medicalRecords.foodFrequencyMap.processedMeat.min Number
medicalRecords.foodFrequencyMap.processedMeat.max Number
medicalRecords.foodFrequencyMap.beansAndPeasOrLentils Object
medicalRecords.foodFrequencyMap.beansAndPeasOrLentils.unit String

week, day
medicalRecords.foodFrequencyMap.beansAndPeasOrLentils.min Number
medicalRecords.foodFrequencyMap.beansAndPeasOrLentils.max Number
medicalRecords.foodFrequencyMap.egg Object
medicalRecords.foodFrequencyMap.egg.unit String

week, day
medicalRecords.foodFrequencyMap.egg.min Number
medicalRecords.foodFrequencyMap.egg.max Number
medicalRecords.foodFrequencyMap.milk Object
medicalRecords.foodFrequencyMap.milk.unit String

week, day
medicalRecords.foodFrequencyMap.milk.min Number
medicalRecords.foodFrequencyMap.milk.max Number
medicalRecords.foodFrequencyMap.cheeseAndYoghurt Object
medicalRecords.foodFrequencyMap.cheeseAndYoghurt.unit String

week, day
medicalRecords.foodFrequencyMap.cheeseAndYoghurt.min Number
medicalRecords.foodFrequencyMap.cheeseAndYoghurt.max Number
medicalRecords.foodFrequencyMap.ricePastaAndBread Object
medicalRecords.foodFrequencyMap.ricePastaAndBread.unit String

week, day
medicalRecords.foodFrequencyMap.ricePastaAndBread.min Number
medicalRecords.foodFrequencyMap.ricePastaAndBread.max Number
medicalRecords.foodFrequencyMap.ricePastaAndBreadWholeGrain Object
medicalRecords.foodFrequencyMap.ricePastaAndBreadWholeGrain.unit String

week, day
medicalRecords.foodFrequencyMap.ricePastaAndBreadWholeGrain.min Number
medicalRecords.foodFrequencyMap.ricePastaAndBreadWholeGrain.max Number
medicalRecords.foodFrequencyMap.fruit Object
medicalRecords.foodFrequencyMap.fruit.unit String

week, day
medicalRecords.foodFrequencyMap.fruit.min Number
medicalRecords.foodFrequencyMap.fruit.max Number
medicalRecords.foodFrequencyMap.vegetable Object
medicalRecords.foodFrequencyMap.vegetable.unit String

week, day
medicalRecords.foodFrequencyMap.vegetable.min Number
medicalRecords.foodFrequencyMap.vegetable.max Number
medicalRecords.foodFrequencyMap.water Object
medicalRecords.foodFrequencyMap.water.unit String

week, day
medicalRecords.foodFrequencyMap.water.min Number
medicalRecords.foodFrequencyMap.water.max Number
medicalRecords.foodFrequencyMap.alcoholicBeverages Object
medicalRecords.foodFrequencyMap.alcoholicBeverages.unit String

week, day
medicalRecords.foodFrequencyMap.alcoholicBeverages.min Number
medicalRecords.foodFrequencyMap.alcoholicBeverages.max Number
medicalRecords.foodFrequencyMap.coffeeAndTea Object
medicalRecords.foodFrequencyMap.coffeeAndTea.unit String

week, day
medicalRecords.foodFrequencyMap.coffeeAndTea.min Number
medicalRecords.foodFrequencyMap.coffeeAndTea.max Number
medicalRecords.foodFrequencyMap.fastFood Object
medicalRecords.foodFrequencyMap.fastFood.unit String

week, day
medicalRecords.foodFrequencyMap.fastFood.min Number
medicalRecords.foodFrequencyMap.fastFood.max Number
medicalRecords.foodRecallMap Object
medicalRecords.foodRecallMap.breakfast String
medicalRecords.foodRecallMap.breakfast.time Number
medicalRecords.foodRecallMap.breakfast.foods String[]
medicalRecords.foodRecallMap.snackAM String
medicalRecords.foodRecallMap.snackAM.time Number
medicalRecords.foodRecallMap.snackAM.foods String[]
medicalRecords.foodRecallMap.lunch String
medicalRecords.foodRecallMap.lunch.time Number
medicalRecords.foodRecallMap.lunch.foods String[]
medicalRecords.foodRecallMap.snackPM String
medicalRecords.foodRecallMap.snackPM.time Number
medicalRecords.foodRecallMap.snackPM.foods String[]
medicalRecords.foodRecallMap.dinner String
medicalRecords.foodRecallMap.dinner.time Number
medicalRecords.foodRecallMap.dinner.foods String[]
medicalRecords.foodRecallMap.snackBeforeBed String
medicalRecords.foodRecallMap.snackBeforeBed.time Number
medicalRecords.foodRecallMap.snackBeforeBed.foods String[]
medicalRecords.nutritionalAssessment String
medicalRecords.dietRX String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "nutritional-assessment",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "nutritional-assessment",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Nutritional Assessment - Get

Back to top

Get a nutritional assessment medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

nutritional-assessment
subtype String
foodLikes String
foodDislikes String
foodAllergies String
nutritionalSupplements String
appetite String
foodFrequencyMap Object
foodFrequencyMap.redMeat Object
foodFrequencyMap.redMeat.unit String

week, day
foodFrequencyMap.redMeat.min Number
foodFrequencyMap.redMeat.max Number
foodFrequencyMap.whiteMeat Object
foodFrequencyMap.whiteMeat.unit String

week, day
foodFrequencyMap.whiteMeat.min Number
foodFrequencyMap.whiteMeat.max Number
foodFrequencyMap.processedMeat Object
foodFrequencyMap.processedMeat.unit String

week, day
foodFrequencyMap.processedMeat.min Number
foodFrequencyMap.processedMeat.max Number
foodFrequencyMap.beansAndPeasOrLentils Object
foodFrequencyMap.beansAndPeasOrLentils.unit String

week, day
foodFrequencyMap.beansAndPeasOrLentils.min Number
foodFrequencyMap.beansAndPeasOrLentils.max Number
foodFrequencyMap.egg Object
foodFrequencyMap.egg.unit String

week, day
foodFrequencyMap.egg.min Number
foodFrequencyMap.egg.max Number
foodFrequencyMap.milk Object
foodFrequencyMap.milk.unit String

week, day
foodFrequencyMap.milk.min Number
foodFrequencyMap.milk.max Number
foodFrequencyMap.cheeseAndYoghurt Object
foodFrequencyMap.cheeseAndYoghurt.unit String

week, day
foodFrequencyMap.cheeseAndYoghurt.min Number
foodFrequencyMap.cheeseAndYoghurt.max Number
foodFrequencyMap.ricePastaAndBread Object
foodFrequencyMap.ricePastaAndBread.unit String

week, day
foodFrequencyMap.ricePastaAndBread.min Number
foodFrequencyMap.ricePastaAndBread.max Number
foodFrequencyMap.ricePastaAndBreadWholeGrain Object
foodFrequencyMap.ricePastaAndBreadWholeGrain.unit String

week, day
foodFrequencyMap.ricePastaAndBreadWholeGrain.min Number
foodFrequencyMap.ricePastaAndBreadWholeGrain.max Number
foodFrequencyMap.fruit Object
foodFrequencyMap.fruit.unit String

week, day
foodFrequencyMap.fruit.min Number
foodFrequencyMap.fruit.max Number
foodFrequencyMap.vegetable Object
foodFrequencyMap.vegetable.unit String

week, day
foodFrequencyMap.vegetable.min Number
foodFrequencyMap.vegetable.max Number
foodFrequencyMap.water Object
foodFrequencyMap.water.unit String

week, day
foodFrequencyMap.water.min Number
foodFrequencyMap.water.max Number
foodFrequencyMap.alcoholicBeverages Object
foodFrequencyMap.alcoholicBeverages.unit String

week, day
foodFrequencyMap.alcoholicBeverages.min Number
foodFrequencyMap.alcoholicBeverages.max Number
foodFrequencyMap.coffeeAndTea Object
foodFrequencyMap.coffeeAndTea.unit String

week, day
foodFrequencyMap.coffeeAndTea.min Number
foodFrequencyMap.coffeeAndTea.max Number
foodFrequencyMap.fastFood Object
foodFrequencyMap.fastFood.unit String

week, day
foodFrequencyMap.fastFood.min Number
foodFrequencyMap.fastFood.max Number
foodRecallMap Object
foodRecallMap.breakfast String
foodRecallMap.breakfast.time Number
foodRecallMap.breakfast.foods String[]
foodRecallMap.snackAM String
foodRecallMap.snackAM.time Number
foodRecallMap.snackAM.foods String[]
foodRecallMap.lunch String
foodRecallMap.lunch.time Number
foodRecallMap.lunch.foods String[]
foodRecallMap.snackPM String
foodRecallMap.snackPM.time Number
foodRecallMap.snackPM.foods String[]
foodRecallMap.dinner String
foodRecallMap.dinner.time Number
foodRecallMap.dinner.foods String[]
foodRecallMap.snackBeforeBed String
foodRecallMap.snackBeforeBed.time Number
foodRecallMap.snackBeforeBed.foods String[]
nutritionalAssessment String
dietRX String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "nutritional-assessment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Nutritional Assessment - Patch

Back to top

Update a nutritional assessment medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
foodLikes String optional
foodDislikes String optional
foodAllergies String optional
nutritionalSupplements String optional
appetite String optional
foodFrequencyMap Object optional
foodFrequencyMap.redMeat Object
foodFrequencyMap.redMeat.unit String

week, day
foodFrequencyMap.redMeat.min Number
foodFrequencyMap.redMeat.max Number
foodFrequencyMap.whiteMeat Object
foodFrequencyMap.whiteMeat.unit String

week, day
foodFrequencyMap.whiteMeat.min Number
foodFrequencyMap.whiteMeat.max Number
foodFrequencyMap.processedMeat Object
foodFrequencyMap.processedMeat.unit String

week, day
foodFrequencyMap.processedMeat.min Number
foodFrequencyMap.processedMeat.max Number
foodFrequencyMap.beansAndPeasOrLentils Object
foodFrequencyMap.beansAndPeasOrLentils.unit String

week, day
foodFrequencyMap.beansAndPeasOrLentils.min Number
foodFrequencyMap.beansAndPeasOrLentils.max Number
foodFrequencyMap.egg Object
foodFrequencyMap.egg.unit String

week, day
foodFrequencyMap.egg.min Number
foodFrequencyMap.egg.max Number
foodFrequencyMap.milk Object
foodFrequencyMap.milk.unit String

week, day
foodFrequencyMap.milk.min Number
foodFrequencyMap.milk.max Number
foodFrequencyMap.cheeseAndYoghurt Object
foodFrequencyMap.cheeseAndYoghurt.unit String

week, day
foodFrequencyMap.cheeseAndYoghurt.min Number
foodFrequencyMap.cheeseAndYoghurt.max Number
foodFrequencyMap.ricePastaAndBread Object
foodFrequencyMap.ricePastaAndBread.unit String

week, day
foodFrequencyMap.ricePastaAndBread.min Number
foodFrequencyMap.ricePastaAndBread.max Number
foodFrequencyMap.ricePastaAndBreadWholeGrain Object
foodFrequencyMap.ricePastaAndBreadWholeGrain.unit String

week, day
foodFrequencyMap.ricePastaAndBreadWholeGrain.min Number
foodFrequencyMap.ricePastaAndBreadWholeGrain.max Number
foodFrequencyMap.fruit Object
foodFrequencyMap.fruit.unit String

week, day
foodFrequencyMap.fruit.min Number
foodFrequencyMap.fruit.max Number
foodFrequencyMap.vegetable Object
foodFrequencyMap.vegetable.unit String

week, day
foodFrequencyMap.vegetable.min Number
foodFrequencyMap.vegetable.max Number
foodFrequencyMap.water Object
foodFrequencyMap.water.unit String

week, day
foodFrequencyMap.water.min Number
foodFrequencyMap.water.max Number
foodFrequencyMap.alcoholicBeverages Object
foodFrequencyMap.alcoholicBeverages.unit String

week, day
foodFrequencyMap.alcoholicBeverages.min Number
foodFrequencyMap.alcoholicBeverages.max Number
foodFrequencyMap.coffeeAndTea Object
foodFrequencyMap.coffeeAndTea.unit String

week, day
foodFrequencyMap.coffeeAndTea.min Number
foodFrequencyMap.coffeeAndTea.max Number
foodFrequencyMap.fastFood Object
foodFrequencyMap.fastFood.unit String

week, day
foodFrequencyMap.fastFood.min Number
foodFrequencyMap.fastFood.max Number
foodRecallMap Object optional
foodRecallMap.breakfast String
foodRecallMap.breakfast.time Number
foodRecallMap.breakfast.foods String[]
foodRecallMap.snackAM String
foodRecallMap.snackAM.time Number
foodRecallMap.snackAM.foods String[]
foodRecallMap.lunch String
foodRecallMap.lunch.time Number
foodRecallMap.lunch.foods String[]
foodRecallMap.snackPM String
foodRecallMap.snackPM.time Number
foodRecallMap.snackPM.foods String[]
foodRecallMap.dinner String
foodRecallMap.dinner.time Number
foodRecallMap.dinner.foods String[]
foodRecallMap.snackBeforeBed String
foodRecallMap.snackBeforeBed.time Number
foodRecallMap.snackBeforeBed.foods String[]
nutritionalAssessment String optional
dietRX String optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "foodLikes": "some foodLikes",
    "foodDislikes": "some foodDislikes"
  }'

Parameters examples

json - Request-Example

{
  "foodLikes": "some foodLikes",
  "foodDislikes": "some foodDislikes"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

nutritional-assessment
subtype String
foodLikes String
foodDislikes String
foodAllergies String
nutritionalSupplements String
appetite String
foodFrequencyMap Object
foodFrequencyMap.redMeat Object
foodFrequencyMap.redMeat.unit String

week, day
foodFrequencyMap.redMeat.min Number
foodFrequencyMap.redMeat.max Number
foodFrequencyMap.whiteMeat Object
foodFrequencyMap.whiteMeat.unit String

week, day
foodFrequencyMap.whiteMeat.min Number
foodFrequencyMap.whiteMeat.max Number
foodFrequencyMap.processedMeat Object
foodFrequencyMap.processedMeat.unit String

week, day
foodFrequencyMap.processedMeat.min Number
foodFrequencyMap.processedMeat.max Number
foodFrequencyMap.beansAndPeasOrLentils Object
foodFrequencyMap.beansAndPeasOrLentils.unit String

week, day
foodFrequencyMap.beansAndPeasOrLentils.min Number
foodFrequencyMap.beansAndPeasOrLentils.max Number
foodFrequencyMap.egg Object
foodFrequencyMap.egg.unit String

week, day
foodFrequencyMap.egg.min Number
foodFrequencyMap.egg.max Number
foodFrequencyMap.milk Object
foodFrequencyMap.milk.unit String

week, day
foodFrequencyMap.milk.min Number
foodFrequencyMap.milk.max Number
foodFrequencyMap.cheeseAndYoghurt Object
foodFrequencyMap.cheeseAndYoghurt.unit String

week, day
foodFrequencyMap.cheeseAndYoghurt.min Number
foodFrequencyMap.cheeseAndYoghurt.max Number
foodFrequencyMap.ricePastaAndBread Object
foodFrequencyMap.ricePastaAndBread.unit String

week, day
foodFrequencyMap.ricePastaAndBread.min Number
foodFrequencyMap.ricePastaAndBread.max Number
foodFrequencyMap.ricePastaAndBreadWholeGrain Object
foodFrequencyMap.ricePastaAndBreadWholeGrain.unit String

week, day
foodFrequencyMap.ricePastaAndBreadWholeGrain.min Number
foodFrequencyMap.ricePastaAndBreadWholeGrain.max Number
foodFrequencyMap.fruit Object
foodFrequencyMap.fruit.unit String

week, day
foodFrequencyMap.fruit.min Number
foodFrequencyMap.fruit.max Number
foodFrequencyMap.vegetable Object
foodFrequencyMap.vegetable.unit String

week, day
foodFrequencyMap.vegetable.min Number
foodFrequencyMap.vegetable.max Number
foodFrequencyMap.water Object
foodFrequencyMap.water.unit String

week, day
foodFrequencyMap.water.min Number
foodFrequencyMap.water.max Number
foodFrequencyMap.alcoholicBeverages Object
foodFrequencyMap.alcoholicBeverages.unit String

week, day
foodFrequencyMap.alcoholicBeverages.min Number
foodFrequencyMap.alcoholicBeverages.max Number
foodFrequencyMap.coffeeAndTea Object
foodFrequencyMap.coffeeAndTea.unit String

week, day
foodFrequencyMap.coffeeAndTea.min Number
foodFrequencyMap.coffeeAndTea.max Number
foodFrequencyMap.fastFood Object
foodFrequencyMap.fastFood.unit String

week, day
foodFrequencyMap.fastFood.min Number
foodFrequencyMap.fastFood.max Number
foodRecallMap Object
foodRecallMap.breakfast String
foodRecallMap.breakfast.time Number
foodRecallMap.breakfast.foods String[]
foodRecallMap.snackAM String
foodRecallMap.snackAM.time Number
foodRecallMap.snackAM.foods String[]
foodRecallMap.lunch String
foodRecallMap.lunch.time Number
foodRecallMap.lunch.foods String[]
foodRecallMap.snackPM String
foodRecallMap.snackPM.time Number
foodRecallMap.snackPM.foods String[]
foodRecallMap.dinner String
foodRecallMap.dinner.time Number
foodRecallMap.dinner.foods String[]
foodRecallMap.snackBeforeBed String
foodRecallMap.snackBeforeBed.time Number
foodRecallMap.snackBeforeBed.foods String[]
nutritionalAssessment String
dietRX String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "nutritional-assessment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Nutritional Assessment - Post

Back to top

Create a medical record for nutritional assessment

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: nutritional-assessment
subtype String optional
foodLikes String optional
foodDislikes String optional
foodAllergies String optional
nutritionalSupplements String optional
appetite String optional
foodFrequencyMap Object optional
foodFrequencyMap.redMeat Object
foodFrequencyMap.redMeat.unit String

week, day
foodFrequencyMap.redMeat.min Number
foodFrequencyMap.redMeat.max Number
foodFrequencyMap.whiteMeat Object
foodFrequencyMap.whiteMeat.unit String

week, day
foodFrequencyMap.whiteMeat.min Number
foodFrequencyMap.whiteMeat.max Number
foodFrequencyMap.processedMeat Object
foodFrequencyMap.processedMeat.unit String

week, day
foodFrequencyMap.processedMeat.min Number
foodFrequencyMap.processedMeat.max Number
foodFrequencyMap.beansAndPeasOrLentils Object
foodFrequencyMap.beansAndPeasOrLentils.unit String

week, day
foodFrequencyMap.beansAndPeasOrLentils.min Number
foodFrequencyMap.beansAndPeasOrLentils.max Number
foodFrequencyMap.egg Object
foodFrequencyMap.egg.unit String

week, day
foodFrequencyMap.egg.min Number
foodFrequencyMap.egg.max Number
foodFrequencyMap.milk Object
foodFrequencyMap.milk.unit String

week, day
foodFrequencyMap.milk.min Number
foodFrequencyMap.milk.max Number
foodFrequencyMap.cheeseAndYoghurt Object
foodFrequencyMap.cheeseAndYoghurt.unit String

week, day
foodFrequencyMap.cheeseAndYoghurt.min Number
foodFrequencyMap.cheeseAndYoghurt.max Number
foodFrequencyMap.ricePastaAndBread Object
foodFrequencyMap.ricePastaAndBread.unit String

week, day
foodFrequencyMap.ricePastaAndBread.min Number
foodFrequencyMap.ricePastaAndBread.max Number
foodFrequencyMap.ricePastaAndBreadWholeGrain Object
foodFrequencyMap.ricePastaAndBreadWholeGrain.unit String

week, day
foodFrequencyMap.ricePastaAndBreadWholeGrain.min Number
foodFrequencyMap.ricePastaAndBreadWholeGrain.max Number
foodFrequencyMap.fruit Object
foodFrequencyMap.fruit.unit String

week, day
foodFrequencyMap.fruit.min Number
foodFrequencyMap.fruit.max Number
foodFrequencyMap.vegetable Object
foodFrequencyMap.vegetable.unit String

week, day
foodFrequencyMap.vegetable.min Number
foodFrequencyMap.vegetable.max Number
foodFrequencyMap.water Object
foodFrequencyMap.water.unit String

week, day
foodFrequencyMap.water.min Number
foodFrequencyMap.water.max Number
foodFrequencyMap.alcoholicBeverages Object
foodFrequencyMap.alcoholicBeverages.unit String

week, day
foodFrequencyMap.alcoholicBeverages.min Number
foodFrequencyMap.alcoholicBeverages.max Number
foodFrequencyMap.coffeeAndTea Object
foodFrequencyMap.coffeeAndTea.unit String

week, day
foodFrequencyMap.coffeeAndTea.min Number
foodFrequencyMap.coffeeAndTea.max Number
foodFrequencyMap.fastFood Object
foodFrequencyMap.fastFood.unit String

week, day
foodFrequencyMap.fastFood.min Number
foodFrequencyMap.fastFood.max Number
foodRecallMap Object optional
foodRecallMap.breakfast String
foodRecallMap.breakfast.time Number
foodRecallMap.breakfast.foods String[]
foodRecallMap.snackAM String
foodRecallMap.snackAM.time Number
foodRecallMap.snackAM.foods String[]
foodRecallMap.lunch String
foodRecallMap.lunch.time Number
foodRecallMap.lunch.foods String[]
foodRecallMap.snackPM String
foodRecallMap.snackPM.time Number
foodRecallMap.snackPM.foods String[]
foodRecallMap.dinner String
foodRecallMap.dinner.time Number
foodRecallMap.dinner.foods String[]
foodRecallMap.snackBeforeBed String
foodRecallMap.snackBeforeBed.time Number
foodRecallMap.snackBeforeBed.foods String[]
nutritionalAssessment String optional
dietRX String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "nutritional-assessment",
    "foodLikes": "some foodLikes",
    "foodDislikes": "some foodDislikes"
  }'

Parameters examples

json - Request-Example

{
  "type": "nutritional-assessment",
  "foodLikes": "some foodLikes",
  "foodDislikes": "some foodDislikes"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

nutritional-assessment
subtype String
foodLikes String
foodDislikes String
foodAllergies String
nutritionalSupplements String
appetite String
foodFrequencyMap Object
foodFrequencyMap.redMeat Object
foodFrequencyMap.redMeat.unit String

week, day
foodFrequencyMap.redMeat.min Number
foodFrequencyMap.redMeat.max Number
foodFrequencyMap.whiteMeat Object
foodFrequencyMap.whiteMeat.unit String

week, day
foodFrequencyMap.whiteMeat.min Number
foodFrequencyMap.whiteMeat.max Number
foodFrequencyMap.processedMeat Object
foodFrequencyMap.processedMeat.unit String

week, day
foodFrequencyMap.processedMeat.min Number
foodFrequencyMap.processedMeat.max Number
foodFrequencyMap.beansAndPeasOrLentils Object
foodFrequencyMap.beansAndPeasOrLentils.unit String

week, day
foodFrequencyMap.beansAndPeasOrLentils.min Number
foodFrequencyMap.beansAndPeasOrLentils.max Number
foodFrequencyMap.egg Object
foodFrequencyMap.egg.unit String

week, day
foodFrequencyMap.egg.min Number
foodFrequencyMap.egg.max Number
foodFrequencyMap.milk Object
foodFrequencyMap.milk.unit String

week, day
foodFrequencyMap.milk.min Number
foodFrequencyMap.milk.max Number
foodFrequencyMap.cheeseAndYoghurt Object
foodFrequencyMap.cheeseAndYoghurt.unit String

week, day
foodFrequencyMap.cheeseAndYoghurt.min Number
foodFrequencyMap.cheeseAndYoghurt.max Number
foodFrequencyMap.ricePastaAndBread Object
foodFrequencyMap.ricePastaAndBread.unit String

week, day
foodFrequencyMap.ricePastaAndBread.min Number
foodFrequencyMap.ricePastaAndBread.max Number
foodFrequencyMap.ricePastaAndBreadWholeGrain Object
foodFrequencyMap.ricePastaAndBreadWholeGrain.unit String

week, day
foodFrequencyMap.ricePastaAndBreadWholeGrain.min Number
foodFrequencyMap.ricePastaAndBreadWholeGrain.max Number
foodFrequencyMap.fruit Object
foodFrequencyMap.fruit.unit String

week, day
foodFrequencyMap.fruit.min Number
foodFrequencyMap.fruit.max Number
foodFrequencyMap.vegetable Object
foodFrequencyMap.vegetable.unit String

week, day
foodFrequencyMap.vegetable.min Number
foodFrequencyMap.vegetable.max Number
foodFrequencyMap.water Object
foodFrequencyMap.water.unit String

week, day
foodFrequencyMap.water.min Number
foodFrequencyMap.water.max Number
foodFrequencyMap.alcoholicBeverages Object
foodFrequencyMap.alcoholicBeverages.unit String

week, day
foodFrequencyMap.alcoholicBeverages.min Number
foodFrequencyMap.alcoholicBeverages.max Number
foodFrequencyMap.coffeeAndTea Object
foodFrequencyMap.coffeeAndTea.unit String

week, day
foodFrequencyMap.coffeeAndTea.min Number
foodFrequencyMap.coffeeAndTea.max Number
foodFrequencyMap.fastFood Object
foodFrequencyMap.fastFood.unit String

week, day
foodFrequencyMap.fastFood.min Number
foodFrequencyMap.fastFood.max Number
foodRecallMap Object
foodRecallMap.breakfast String
foodRecallMap.breakfast.time Number
foodRecallMap.breakfast.foods String[]
foodRecallMap.snackAM String
foodRecallMap.snackAM.time Number
foodRecallMap.snackAM.foods String[]
foodRecallMap.lunch String
foodRecallMap.lunch.time Number
foodRecallMap.lunch.foods String[]
foodRecallMap.snackPM String
foodRecallMap.snackPM.time Number
foodRecallMap.snackPM.foods String[]
foodRecallMap.dinner String
foodRecallMap.dinner.time Number
foodRecallMap.dinner.foods String[]
foodRecallMap.snackBeforeBed String
foodRecallMap.snackBeforeBed.time Number
foodRecallMap.snackBeforeBed.foods String[]
nutritionalAssessment String
dietRX String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "nutritional-assessment",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Nutritional Plan - Delete

Back to top

Delete an nutritional plan medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

nutritional-plan
subtype String
breakfast Object
breakfast.time Number
breakfast.rice Object

rice or substitures
breakfast.rice.amount Number
breakfast.rice.sample String
breakfast.meat Object

meat, poultry, egg, fish, beans, or nuts
breakfast.meat.amount Number
breakfast.meat.sample String
breakfast.vegetables Object
breakfast.vegetables.amount Number
breakfast.vegetables.sample String
breakfast.fat Object

fats or oil
breakfast.fat.amount Number
breakfast.fat.sample String
breakfast.fruit Object
breakfast.fruit.amount Number
breakfast.fruit.sample String
breakfast.milk Object

milk and milk products
breakfast.milk.amount Number
breakfast.milk.sample String
breakfast.sugar Object
breakfast.sugar.amount Number
breakfast.sugar.sample String
snackAM Object
snackAM.time Number
snackAM.time.amount Number
snackAM.time.sample String
snackAM.rice Object

rice or substitures
snackAM.rice.amount Number
snackAM.rice.sample String
snackAM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackAM.meat.amount Number
snackAM.meat.sample String
snackAM.vegetables Object
snackAM.vegetables.amount Number
snackAM.vegetables.sample String
snackAM.fat Object

fats or oil
snackAM.fat.amount Number
snackAM.fat.sample String
snackAM.fruit Object
snackAM.fruit.amount Number
snackAM.fruit.sample String
snackAM.milk Object

milk and milk products
snackAM.milk.amount Number
snackAM.milk.sample String
snackAM.sugar Object
snackAM.sugar.amount Number
snackAM.sugar.sample String
lunch Object
lunch.time Number
lunch.rice Object

rice or substitures
lunch.rice.amount Number
lunch.rice.sample String
lunch.meat Object

meat, poultry, egg, fish, beans, or nuts
lunch.meat.amount Number
lunch.meat.sample String
lunch.vegetables Object
lunch.vegetables.amount Number
lunch.vegetables.sample String
lunch.fat Object

fats or oil
lunch.fat.amount Number
lunch.fat.sample String
lunch.fruit Object
lunch.fruit.amount Number
lunch.fruit.sample String
lunch.milk Object

milk and milk products
lunch.milk.amount Number
lunch.milk.sample String
lunch.sugar Object
lunch.sugar.amount Number
lunch.sugar.sample String
snackPM Object
snackPM.time Number
snackPM.rice Object

rice or substitures
snackPM.rice.amount Number
snackPM.rice.sample String
snackPM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackPM.meat.amount Number
snackPM.meat.sample String
snackPM.vegetables Object
snackPM.vegetables.amount Number
snackPM.vegetables.sample String
snackPM.fat Object

fats or oil
snackPM.fat.amount Number
snackPM.fat.sample String
snackPM.fruit Object
snackPM.fruit.amount Number
snackPM.fruit.sample String
snackPM.milk Object

milk and milk products
snackPM.milk.amount Number
snackPM.milk.sample String
snackPM.sugar Object
snackPM.sugar.amount Number
snackPM.sugar.sample String
dinner Object
dinner.time Number
dinner.rice Object

rice or substitures
dinner.rice.amount Number
dinner.rice.sample String
dinner.meat Object

meat, poultry, egg, fish, beans, or nuts
dinner.meat.amount Number
dinner.meat.sample String
dinner.vegetables Object
dinner.vegetables.amount Number
dinner.vegetables.sample String
dinner.fat Object

fats or oil
dinner.fat.amount Number
dinner.fat.sample String
dinner.fruit Object
dinner.fruit.amount Number
dinner.fruit.sample String
dinner.milk Object

milk and milk products
dinner.milk.amount Number
dinner.milk.sample String
dinner.sugar Object
dinner.sugar.amount Number
dinner.sugar.sample String
snackBeforeBed Object
snackBeforeBed.time Number
snackBeforeBed.rice Object

rice or substitures
snackBeforeBed.rice.amount Number
snackBeforeBed.rice.sample String
snackBeforeBed.meat Object

meat, poultry, egg, fish, beans, or nuts
snackBeforeBed.meat.amount Number
snackBeforeBed.meat.sample String
snackBeforeBed.vegetables Object
snackBeforeBed.vegetables.amount Number
snackBeforeBed.vegetables.sample String
snackBeforeBed.fat Object

fats or oil
snackBeforeBed.fat.amount Number
snackBeforeBed.fat.sample String
snackBeforeBed.fruit Object
snackBeforeBed.fruit.amount Number
snackBeforeBed.fruit.sample String
snackBeforeBed.milk Object

milk and milk products
snackBeforeBed.milk.amount Number
snackBeforeBed.milk.sample String
snackBeforeBed.sugar Object
snackBeforeBed.sugar.amount Number
snackBeforeBed.sugar.sample String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "nutritional-plan",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Nutritional Plan - Find

Back to top

Get nutritional plan medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=nutritional-plan" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

nutritional-plan
medicalRecords.subtype String
medicalRecords.breakfast Object
medicalRecords.breakfast.time Number
medicalRecords.breakfast.rice Object

rice or substitures
medicalRecords.breakfast.rice.amount Number
medicalRecords.breakfast.rice.sample String
medicalRecords.breakfast.meat Object

meat, poultry, egg, fish, beans, or nuts
medicalRecords.breakfast.meat.amount Number
medicalRecords.breakfast.meat.sample String
medicalRecords.breakfast.vegetables Object
medicalRecords.breakfast.vegetables.amount Number
medicalRecords.breakfast.vegetables.sample String
medicalRecords.breakfast.fat Object

fats or oil
medicalRecords.breakfast.fat.amount Number
medicalRecords.breakfast.fat.sample String
medicalRecords.breakfast.fruit Object
medicalRecords.breakfast.fruit.amount Number
medicalRecords.breakfast.fruit.sample String
medicalRecords.breakfast.milk Object

milk and milk products
medicalRecords.breakfast.milk.amount Number
medicalRecords.breakfast.milk.sample String
medicalRecords.breakfast.sugar Object
medicalRecords.breakfast.sugar.amount Number
medicalRecords.breakfast.sugar.sample String
medicalRecords.snackAM Object
medicalRecords.snackAM.time Number
medicalRecords.snackAM.time.amount Number
medicalRecords.snackAM.time.sample String
medicalRecords.snackAM.rice Object

rice or substitures
medicalRecords.snackAM.rice.amount Number
medicalRecords.snackAM.rice.sample String
medicalRecords.snackAM.meat Object

meat, poultry, egg, fish, beans, or nuts
medicalRecords.snackAM.meat.amount Number
medicalRecords.snackAM.meat.sample String
medicalRecords.snackAM.vegetables Object
medicalRecords.snackAM.vegetables.amount Number
medicalRecords.snackAM.vegetables.sample String
medicalRecords.snackAM.fat Object

fats or oil
medicalRecords.snackAM.fat.amount Number
medicalRecords.snackAM.fat.sample String
medicalRecords.snackAM.fruit Object
medicalRecords.snackAM.fruit.amount Number
medicalRecords.snackAM.fruit.sample String
medicalRecords.snackAM.milk Object

milk and milk products
medicalRecords.snackAM.milk.amount Number
medicalRecords.snackAM.milk.sample String
medicalRecords.snackAM.sugar Object
medicalRecords.snackAM.sugar.amount Number
medicalRecords.sugar.sample String
medicalRecords.lunch Object
medicalRecords.lunch.time Number
medicalRecords.lunch.rice Object

rice or substitures
medicalRecords.lunch.rice.amount Number
medicalRecords.lunch.rice.sample String
medicalRecords.lunch.meat Object

meat, poultry, egg, fish, beans, or nuts
medicalRecords.lunch.meat.amount Number
medicalRecords.lunch.meat.sample String
medicalRecords.lunch.vegetables Object
medicalRecords.lunch.vegetables.amount Number
medicalRecords.lunch.vegetables.sample String
medicalRecords.lunch.fat Object

fats or oil
medicalRecords.lunch.fat.amount Number
medicalRecords.lunch.fat.sample String
medicalRecords.lunch.fruit Object
medicalRecords.lunch.fruit.amount Number
medicalRecords.lunch.fruit.sample String
medicalRecords.lunch.milk Object

milk and milk products
medicalRecords.lunch.milk.amount Number
medicalRecords.lunch.milk.sample String
medicalRecords.lunch.sugar Object
medicalRecords.lunch.sugar.amount Number
medicalRecords.snackPM Object
medicalRecords.snackPM.time Number
medicalRecords.snackPM.rice Object

rice or substitures
medicalRecords.snackPM.rice.amount Number
medicalRecords.snackPM.rice.sample String
medicalRecords.snackPM.meat Object

meat, poultry, egg, fish, beans, or nuts
medicalRecords.snackPM.meat.amount Number
medicalRecords.snackPM.meat.sample String
medicalRecords.snackPM.vegetables Object
medicalRecords.snackPM.vegetables.amount Number
medicalRecords.snackPM.vegetables.sample String
medicalRecords.snackPM.fat Object

fats or oil
medicalRecords.snackPM.fat.amount Number
medicalRecords.snackPM.fat.sample String
medicalRecords.snackPM.fruit Object
medicalRecords.snackPM.fruit.amount Number
medicalRecords.snackPM.fruit.sample String
medicalRecords.snackPM.milk Object

milk and milk products
medicalRecords.snackPM.milk.amount Number
medicalRecords.snackPM.milk.sample String
medicalRecords.snackPM.sugar Object
medicalRecords.snackPM.sugar.amount Number
medicalRecords.dinner Object
medicalRecords.dinner.time Number
medicalRecords.dinner.rice Object

rice or substitures
medicalRecords.dinner.rice.amount Number
medicalRecords.dinner.rice.sample String
medicalRecords.dinner.meat Object

meat, poultry, egg, fish, beans, or nuts
medicalRecords.dinner.meat.amount Number
medicalRecords.dinner.meat.sample String
medicalRecords.dinner.vegetables Object
medicalRecords.dinner.vegetables.amount Number
medicalRecords.dinner.vegetables.sample String
medicalRecords.dinner.fat Object

fats or oil
medicalRecords.dinner.fat.amount Number
medicalRecords.dinner.fat.sample String
medicalRecords.dinner.fruit Object
medicalRecords.dinner.fruit.amount Number
medicalRecords.dinner.fruit.sample String
medicalRecords.dinner.milk Object

milk and milk products
medicalRecords.dinner.milk.amount Number
medicalRecords.dinner.milk.sample String
medicalRecords.dinner.sugar Object
medicalRecords.dinner.sugar.amount Number
medicalRecords.snackBeforeBed Object
medicalRecords.snackBeforeBed.time Number
medicalRecords.snackBeforeBed.rice Object

rice or substitures
medicalRecords.snackBeforeBed.rice.amount Number
medicalRecords.snackBeforeBed.rice.sample String
medicalRecords.snackBeforeBed.meat Object

meat, poultry, egg, fish, beans, or nuts
medicalRecords.snackBeforeBed.meat.amount Number
medicalRecords.snackBeforeBed.meat.sample String
medicalRecords.snackBeforeBed.vegetables Object
medicalRecords.snackBeforeBed.vegetables.amount Number
medicalRecords.snackBeforeBed.vegetables.sample String
medicalRecords.snackBeforeBed.fat Object

fats or oil
medicalRecords.snackBeforeBed.fat.amount Number
medicalRecords.snackBeforeBed.fat.sample String
medicalRecords.snackBeforeBed.fruit Object
medicalRecords.snackBeforeBed.fruit.amount Number
medicalRecords.snackBeforeBed.fruit.sample String
medicalRecords.snackBeforeBed.milk Object

milk and milk products
medicalRecords.snackBeforeBed.milk.amount Number
medicalRecords.snackBeforeBed.milk.sample String
medicalRecords.snackBeforeBed.sugar Object
medicalRecords.snackBeforeBed.sugar.amount Number
medicalRecords.snackBeforeBed.sugar.sample String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "nutritional-plan",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "nutritional-plan",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Nutritional Plan - Get

Back to top

Get an nutritional plan medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

nutritional-plan
subtype String
breakfast Object
breakfast.time Number
breakfast.rice Object

rice or substitures
breakfast.rice.amount Number
breakfast.rice.sample String
breakfast.meat Object

meat, poultry, egg, fish, beans, or nuts
breakfast.meat.amount Number
breakfast.meat.sample String
breakfast.vegetables Object
breakfast.vegetables.amount Number
breakfast.vegetables.sample String
breakfast.fat Object

fats or oil
breakfast.fat.amount Number
breakfast.fat.sample String
breakfast.fruit Object
breakfast.fruit.amount Number
breakfast.fruit.sample String
breakfast.milk Object

milk and milk products
breakfast.milk.amount Number
breakfast.milk.sample String
breakfast.sugar Object
breakfast.sugar.amount Number
breakfast.sugar.sample String
snackAM Object
snackAM.time Number
snackAM.time.amount Number
snackAM.time.sample String
snackAM.rice Object

rice or substitures
snackAM.rice.amount Number
snackAM.rice.sample String
snackAM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackAM.meat.amount Number
snackAM.meat.sample String
snackAM.vegetables Object
snackAM.vegetables.amount Number
snackAM.vegetables.sample String
snackAM.fat Object

fats or oil
snackAM.fat.amount Number
snackAM.fat.sample String
snackAM.fruit Object
snackAM.fruit.amount Number
snackAM.fruit.sample String
snackAM.milk Object

milk and milk products
snackAM.milk.amount Number
snackAM.milk.sample String
snackAM.sugar Object
snackAM.sugar.amount Number
snackAM.sugar.sample String
lunch Object
lunch.time Number
lunch.rice Object

rice or substitures
lunch.rice.amount Number
lunch.rice.sample String
lunch.meat Object

meat, poultry, egg, fish, beans, or nuts
lunch.meat.amount Number
lunch.meat.sample String
lunch.vegetables Object
lunch.vegetables.amount Number
lunch.vegetables.sample String
lunch.fat Object

fats or oil
lunch.fat.amount Number
lunch.fat.sample String
lunch.fruit Object
lunch.fruit.amount Number
lunch.fruit.sample String
lunch.milk Object

milk and milk products
lunch.milk.amount Number
lunch.milk.sample String
lunch.sugar Object
lunch.sugar.amount Number
lunch.sugar.sample String
snackPM Object
snackPM.time Number
snackPM.rice Object

rice or substitures
snackPM.rice.amount Number
snackPM.rice.sample String
snackPM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackPM.meat.amount Number
snackPM.meat.sample String
snackPM.vegetables Object
snackPM.vegetables.amount Number
snackPM.vegetables.sample String
snackPM.fat Object

fats or oil
snackPM.fat.amount Number
snackPM.fat.sample String
snackPM.fruit Object
snackPM.fruit.amount Number
snackPM.fruit.sample String
snackPM.milk Object

milk and milk products
snackPM.milk.amount Number
snackPM.milk.sample String
snackPM.sugar Object
snackPM.sugar.amount Number
snackPM.sugar.sample String
dinner Object
dinner.time Number
dinner.rice Object

rice or substitures
dinner.rice.amount Number
dinner.rice.sample String
dinner.meat Object

meat, poultry, egg, fish, beans, or nuts
dinner.meat.amount Number
dinner.meat.sample String
dinner.vegetables Object
dinner.vegetables.amount Number
dinner.vegetables.sample String
dinner.fat Object

fats or oil
dinner.fat.amount Number
dinner.fat.sample String
dinner.fruit Object
dinner.fruit.amount Number
dinner.fruit.sample String
dinner.milk Object

milk and milk products
dinner.milk.amount Number
dinner.milk.sample String
dinner.sugar Object
dinner.sugar.amount Number
dinner.sugar.sample String
snackBeforeBed Object
snackBeforeBed.time Number
snackBeforeBed.rice Object

rice or substitures
snackBeforeBed.rice.amount Number
snackBeforeBed.rice.sample String
snackBeforeBed.meat Object

meat, poultry, egg, fish, beans, or nuts
snackBeforeBed.meat.amount Number
snackBeforeBed.meat.sample String
snackBeforeBed.vegetables Object
snackBeforeBed.vegetables.amount Number
snackBeforeBed.vegetables.sample String
snackBeforeBed.fat Object

fats or oil
snackBeforeBed.fat.amount Number
snackBeforeBed.fat.sample String
snackBeforeBed.fruit Object
snackBeforeBed.fruit.amount Number
snackBeforeBed.fruit.sample String
snackBeforeBed.milk Object

milk and milk products
snackBeforeBed.milk.amount Number
snackBeforeBed.milk.sample String
snackBeforeBed.sugar Object
snackBeforeBed.sugar.amount Number
snackBeforeBed.sugar.sample String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "nutritional-plan",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Nutritional Plan - Patch

Back to top

Update an nutritional plan medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
breakfast Object optional
breakfast.time Number
breakfast.rice Object

rice or substitures
breakfast.rice.amount Number
breakfast.rice.sample String
breakfast.meat Object

meat, poultry, egg, fish, beans, or nuts
breakfast.meat.amount Number
breakfast.meat.sample String
breakfast.vegetables Object
breakfast.vegetables.amount Number
breakfast.vegetables.sample String
breakfast.fat Object

fats or oil
breakfast.fat.amount Number
breakfast.fat.sample String
breakfast.fruit Object
breakfast.fruit.amount Number
breakfast.fruit.sample String
breakfast.milk Object

milk and milk products
breakfast.milk.amount Number
breakfast.milk.sample String
breakfast.sugar Object
breakfast.sugar.amount Number
breakfast.sugar.sample String
snackAM Object optional
snackAM.time Number
snackAM.time.amount Number
snackAM.time.sample String
snackAM.rice Object

rice or substitures
snackAM.rice.amount Number
snackAM.rice.sample String
snackAM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackAM.meat.amount Number
snackAM.meat.sample String
snackAM.vegetables Object
snackAM.vegetables.amount Number
snackAM.vegetables.sample String
snackAM.fat Object

fats or oil
snackAM.fat.amount Number
snackAM.fat.sample String
snackAM.fruit Object
snackAM.fruit.amount Number
snackAM.fruit.sample String
snackAM.milk Object

milk and milk products
snackAM.milk.amount Number
snackAM.milk.sample String
snackAM.sugar Object
snackAM.sugar.amount Number
snackAM.sugar.sample String
lunch Object optional
lunch.time Number
lunch.rice Object

rice or substitures
lunch.rice.amount Number
lunch.rice.sample String
lunch.meat Object

meat, poultry, egg, fish, beans, or nuts
lunch.meat.amount Number
lunch.meat.sample String
lunch.vegetables Object
lunch.vegetables.amount Number
lunch.vegetables.sample String
lunch.fat Object

fats or oil
lunch.fat.amount Number
lunch.fat.sample String
lunch.fruit Object
lunch.fruit.amount Number
lunch.fruit.sample String
lunch.milk Object

milk and milk products
lunch.milk.amount Number
lunch.milk.sample String
lunch.sugar Object
lunch.sugar.amount Number
lunch.sugar.sample String
snackPM Object optional
snackPM.time Number
snackPM.rice Object

rice or substitures
snackPM.rice.amount Number
snackPM.rice.sample String
snackPM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackPM.meat.amount Number
snackPM.meat.sample String
snackPM.vegetables Object
snackPM.vegetables.amount Number
snackPM.vegetables.sample String
snackPM.fat Object

fats or oil
snackPM.fat.amount Number
snackPM.fat.sample String
snackPM.fruit Object
snackPM.fruit.amount Number
snackPM.fruit.sample String
snackPM.milk Object

milk and milk products
snackPM.milk.amount Number
snackPM.milk.sample String
snackPM.sugar Object
snackPM.sugar.amount Number
snackPM.sugar.sample String
dinner Object optional
dinner.time Number
dinner.rice Object

rice or substitures
dinner.rice.amount Number
dinner.rice.sample String
dinner.meat Object

meat, poultry, egg, fish, beans, or nuts
dinner.meat.amount Number
dinner.meat.sample String
dinner.vegetables Object
dinner.vegetables.amount Number
dinner.vegetables.sample String
dinner.fat Object

fats or oil
dinner.fat.amount Number
dinner.fat.sample String
dinner.fruit Object
dinner.fruit.amount Number
dinner.fruit.sample String
dinner.milk Object

milk and milk products
dinner.milk.amount Number
dinner.milk.sample String
dinner.sugar Object
dinner.sugar.amount Number
dinner.sugar.sample String
snackBeforeBed Object optional
snackBeforeBed.time Number
snackBeforeBed.rice Object

rice or substitures
snackBeforeBed.rice.amount Number
snackBeforeBed.rice.sample String
snackBeforeBed.meat Object

meat, poultry, egg, fish, beans, or nuts
snackBeforeBed.meat.amount Number
snackBeforeBed.meat.sample String
snackBeforeBed.vegetables Object
snackBeforeBed.vegetables.amount Number
snackBeforeBed.vegetables.sample String
snackBeforeBed.fat Object

fats or oil
snackBeforeBed.fat.amount Number
snackBeforeBed.fat.sample String
snackBeforeBed.fruit Object
snackBeforeBed.fruit.amount Number
snackBeforeBed.fruit.sample String
snackBeforeBed.milk Object

milk and milk products
snackBeforeBed.milk.amount Number
snackBeforeBed.milk.sample String
snackBeforeBed.sugar Object
snackBeforeBed.sugar.amount Number
snackBeforeBed.sugar.sample String
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "breakfast": {time: 123123123}
  }'

Parameters examples

json - Request-Example

{
  "breakfast": {time: 123123123}
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

nutritional-plan
subtype String
breakfast Object
breakfast.time Number
breakfast.rice Object

rice or substitures
breakfast.rice.amount Number
breakfast.rice.sample String
breakfast.meat Object

meat, poultry, egg, fish, beans, or nuts
breakfast.meat.amount Number
breakfast.meat.sample String
breakfast.vegetables Object
breakfast.vegetables.amount Number
breakfast.vegetables.sample String
breakfast.fat Object

fats or oil
breakfast.fat.amount Number
breakfast.fat.sample String
breakfast.fruit Object
breakfast.fruit.amount Number
breakfast.fruit.sample String
breakfast.milk Object

milk and milk products
breakfast.milk.amount Number
breakfast.milk.sample String
breakfast.sugar Object
breakfast.sugar.amount Number
breakfast.sugar.sample String
snackAM Object
snackAM.time Number
snackAM.time.amount Number
snackAM.time.sample String
snackAM.rice Object

rice or substitures
snackAM.rice.amount Number
snackAM.rice.sample String
snackAM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackAM.meat.amount Number
snackAM.meat.sample String
snackAM.vegetables Object
snackAM.vegetables.amount Number
snackAM.vegetables.sample String
snackAM.fat Object

fats or oil
snackAM.fat.amount Number
snackAM.fat.sample String
snackAM.fruit Object
snackAM.fruit.amount Number
snackAM.fruit.sample String
snackAM.milk Object

milk and milk products
snackAM.milk.amount Number
snackAM.milk.sample String
snackAM.sugar Object
snackAM.sugar.amount Number
snackAM.sugar.sample String
lunch Object
lunch.time Number
lunch.rice Object

rice or substitures
lunch.rice.amount Number
lunch.rice.sample String
lunch.meat Object

meat, poultry, egg, fish, beans, or nuts
lunch.meat.amount Number
lunch.meat.sample String
lunch.vegetables Object
lunch.vegetables.amount Number
lunch.vegetables.sample String
lunch.fat Object

fats or oil
lunch.fat.amount Number
lunch.fat.sample String
lunch.fruit Object
lunch.fruit.amount Number
lunch.fruit.sample String
lunch.milk Object

milk and milk products
lunch.milk.amount Number
lunch.milk.sample String
lunch.sugar Object
lunch.sugar.amount Number
lunch.sugar.sample String
snackPM Object
snackPM.time Number
snackPM.rice Object

rice or substitures
snackPM.rice.amount Number
snackPM.rice.sample String
snackPM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackPM.meat.amount Number
snackPM.meat.sample String
snackPM.vegetables Object
snackPM.vegetables.amount Number
snackPM.vegetables.sample String
snackPM.fat Object

fats or oil
snackPM.fat.amount Number
snackPM.fat.sample String
snackPM.fruit Object
snackPM.fruit.amount Number
snackPM.fruit.sample String
snackPM.milk Object

milk and milk products
snackPM.milk.amount Number
snackPM.milk.sample String
snackPM.sugar Object
snackPM.sugar.amount Number
snackPM.sugar.sample String
dinner Object
dinner.time Number
dinner.rice Object

rice or substitures
dinner.rice.amount Number
dinner.rice.sample String
dinner.meat Object

meat, poultry, egg, fish, beans, or nuts
dinner.meat.amount Number
dinner.meat.sample String
dinner.vegetables Object
dinner.vegetables.amount Number
dinner.vegetables.sample String
dinner.fat Object

fats or oil
dinner.fat.amount Number
dinner.fat.sample String
dinner.fruit Object
dinner.fruit.amount Number
dinner.fruit.sample String
dinner.milk Object

milk and milk products
dinner.milk.amount Number
dinner.milk.sample String
dinner.sugar Object
dinner.sugar.amount Number
dinner.sugar.sample String
snackBeforeBed Object
snackBeforeBed.time Number
snackBeforeBed.rice Object

rice or substitures
snackBeforeBed.rice.amount Number
snackBeforeBed.rice.sample String
snackBeforeBed.meat Object

meat, poultry, egg, fish, beans, or nuts
snackBeforeBed.meat.amount Number
snackBeforeBed.meat.sample String
snackBeforeBed.vegetables Object
snackBeforeBed.vegetables.amount Number
snackBeforeBed.vegetables.sample String
snackBeforeBed.fat Object

fats or oil
snackBeforeBed.fat.amount Number
snackBeforeBed.fat.sample String
snackBeforeBed.fruit Object
snackBeforeBed.fruit.amount Number
snackBeforeBed.fruit.sample String
snackBeforeBed.milk Object

milk and milk products
snackBeforeBed.milk.amount Number
snackBeforeBed.milk.sample String
snackBeforeBed.sugar Object
snackBeforeBed.sugar.amount Number
snackBeforeBed.sugar.sample String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "nutritional-plan",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Nutritional Plan - Post

Back to top

Create a medical record for nutritional plan

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: nutritional-plan
subtype String optional
breakfast Object optional
breakfast.time Number
breakfast.rice Object

rice or substitures
breakfast.rice.amount Number
breakfast.rice.sample String
breakfast.meat Object

meat, poultry, egg, fish, beans, or nuts
breakfast.meat.amount Number
breakfast.meat.sample String
breakfast.vegetables Object
breakfast.vegetables.amount Number
breakfast.vegetables.sample String
breakfast.fat Object

fats or oil
breakfast.fat.amount Number
breakfast.fat.sample String
breakfast.fruit Object
breakfast.fruit.amount Number
breakfast.fruit.sample String
breakfast.milk Object

milk and milk products
breakfast.milk.amount Number
breakfast.milk.sample String
breakfast.sugar Object
breakfast.sugar.amount Number
breakfast.sugar.sample String
snackAM Object optional
snackAM.time Number
snackAM.time.amount Number
snackAM.time.sample String
snackAM.rice Object

rice or substitures
snackAM.rice.amount Number
snackAM.rice.sample String
snackAM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackAM.meat.amount Number
snackAM.meat.sample String
snackAM.vegetables Object
snackAM.vegetables.amount Number
snackAM.vegetables.sample String
snackAM.fat Object

fats or oil
snackAM.fat.amount Number
snackAM.fat.sample String
snackAM.fruit Object
snackAM.fruit.amount Number
snackAM.fruit.sample String
snackAM.milk Object

milk and milk products
snackAM.milk.amount Number
snackAM.milk.sample String
snackAM.sugar Object
snackAM.sugar.amount Number
snackAM.sugar.sample String
lunch Object optional
lunch.time Number
lunch.rice Object

rice or substitures
lunch.rice.amount Number
lunch.rice.sample String
lunch.meat Object

meat, poultry, egg, fish, beans, or nuts
lunch.meat.amount Number
lunch.meat.sample String
lunch.vegetables Object
lunch.vegetables.amount Number
lunch.vegetables.sample String
lunch.fat Object

fats or oil
lunch.fat.amount Number
lunch.fat.sample String
lunch.fruit Object
lunch.fruit.amount Number
lunch.fruit.sample String
lunch.milk Object

milk and milk products
lunch.milk.amount Number
lunch.milk.sample String
lunch.sugar Object
lunch.sugar.amount Number
lunch.sugar.sample String
snackPM Object optional
snackPM.time Number
snackPM.rice Object

rice or substitures
snackPM.rice.amount Number
snackPM.rice.sample String
snackPM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackPM.meat.amount Number
snackPM.meat.sample String
snackPM.vegetables Object
snackPM.vegetables.amount Number
snackPM.vegetables.sample String
snackPM.fat Object

fats or oil
snackPM.fat.amount Number
snackPM.fat.sample String
snackPM.fruit Object
snackPM.fruit.amount Number
snackPM.fruit.sample String
snackPM.milk Object

milk and milk products
snackPM.milk.amount Number
snackPM.milk.sample String
snackPM.sugar Object
snackPM.sugar.amount Number
snackPM.sugar.sample String
dinner Object optional
dinner.time Number
dinner.rice Object

rice or substitures
dinner.rice.amount Number
dinner.rice.sample String
dinner.meat Object

meat, poultry, egg, fish, beans, or nuts
dinner.meat.amount Number
dinner.meat.sample String
dinner.vegetables Object
dinner.vegetables.amount Number
dinner.vegetables.sample String
dinner.fat Object

fats or oil
dinner.fat.amount Number
dinner.fat.sample String
dinner.fruit Object
dinner.fruit.amount Number
dinner.fruit.sample String
dinner.milk Object

milk and milk products
dinner.milk.amount Number
dinner.milk.sample String
dinner.sugar Object
dinner.sugar.amount Number
dinner.sugar.sample String
snackBeforeBed Object optional
snackBeforeBed.time Number
snackBeforeBed.rice Object

rice or substitures
snackBeforeBed.rice.amount Number
snackBeforeBed.rice.sample String
snackBeforeBed.meat Object

meat, poultry, egg, fish, beans, or nuts
snackBeforeBed.meat.amount Number
snackBeforeBed.meat.sample String
snackBeforeBed.vegetables Object
snackBeforeBed.vegetables.amount Number
snackBeforeBed.vegetables.sample String
snackBeforeBed.fat Object

fats or oil
snackBeforeBed.fat.amount Number
snackBeforeBed.fat.sample String
snackBeforeBed.fruit Object
snackBeforeBed.fruit.amount Number
snackBeforeBed.fruit.sample String
snackBeforeBed.milk Object

milk and milk products
snackBeforeBed.milk.amount Number
snackBeforeBed.milk.sample String
snackBeforeBed.sugar Object
snackBeforeBed.sugar.amount Number
snackBeforeBed.sugar.sample String
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "nutritional-plan",
    "breakfast": {time: 123123123}
  }'

Parameters examples

json - Request-Example

{
  "type": "nutritional-plan",
  "breakfast": {time: 123123123}
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

nutritional-plan
subtype String
breakfast Object
breakfast.time Number
breakfast.rice Object

rice or substitures
breakfast.rice.amount Number
breakfast.rice.sample String
breakfast.meat Object

meat, poultry, egg, fish, beans, or nuts
breakfast.meat.amount Number
breakfast.meat.sample String
breakfast.vegetables Object
breakfast.vegetables.amount Number
breakfast.vegetables.sample String
breakfast.fat Object

fats or oil
breakfast.fat.amount Number
breakfast.fat.sample String
breakfast.fruit Object
breakfast.fruit.amount Number
breakfast.fruit.sample String
breakfast.milk Object

milk and milk products
breakfast.milk.amount Number
breakfast.milk.sample String
breakfast.sugar Object
breakfast.sugar.amount Number
breakfast.sugar.sample String
snackAM Object
snackAM.time Number
snackAM.time.amount Number
snackAM.time.sample String
snackAM.rice Object

rice or substitures
snackAM.rice.amount Number
snackAM.rice.sample String
snackAM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackAM.meat.amount Number
snackAM.meat.sample String
snackAM.vegetables Object
snackAM.vegetables.amount Number
snackAM.vegetables.sample String
snackAM.fat Object

fats or oil
snackAM.fat.amount Number
snackAM.fat.sample String
snackAM.fruit Object
snackAM.fruit.amount Number
snackAM.fruit.sample String
snackAM.milk Object

milk and milk products
snackAM.milk.amount Number
snackAM.milk.sample String
snackAM.sugar Object
snackAM.sugar.amount Number
snackAM.sugar.sample String
lunch Object
lunch.time Number
lunch.rice Object

rice or substitures
lunch.rice.amount Number
lunch.rice.sample String
lunch.meat Object

meat, poultry, egg, fish, beans, or nuts
lunch.meat.amount Number
lunch.meat.sample String
lunch.vegetables Object
lunch.vegetables.amount Number
lunch.vegetables.sample String
lunch.fat Object

fats or oil
lunch.fat.amount Number
lunch.fat.sample String
lunch.fruit Object
lunch.fruit.amount Number
lunch.fruit.sample String
lunch.milk Object

milk and milk products
lunch.milk.amount Number
lunch.milk.sample String
lunch.sugar Object
lunch.sugar.amount Number
lunch.sugar.sample String
snackPM Object
snackPM.time Number
snackPM.rice Object

rice or substitures
snackPM.rice.amount Number
snackPM.rice.sample String
snackPM.meat Object

meat, poultry, egg, fish, beans, or nuts
snackPM.meat.amount Number
snackPM.meat.sample String
snackPM.vegetables Object
snackPM.vegetables.amount Number
snackPM.vegetables.sample String
snackPM.fat Object

fats or oil
snackPM.fat.amount Number
snackPM.fat.sample String
snackPM.fruit Object
snackPM.fruit.amount Number
snackPM.fruit.sample String
snackPM.milk Object

milk and milk products
snackPM.milk.amount Number
snackPM.milk.sample String
snackPM.sugar Object
snackPM.sugar.amount Number
snackPM.sugar.sample String
dinner Object
dinner.time Number
dinner.rice Object

rice or substitures
dinner.rice.amount Number
dinner.rice.sample String
dinner.meat Object

meat, poultry, egg, fish, beans, or nuts
dinner.meat.amount Number
dinner.meat.sample String
dinner.vegetables Object
dinner.vegetables.amount Number
dinner.vegetables.sample String
dinner.fat Object

fats or oil
dinner.fat.amount Number
dinner.fat.sample String
dinner.fruit Object
dinner.fruit.amount Number
dinner.fruit.sample String
dinner.milk Object

milk and milk products
dinner.milk.amount Number
dinner.milk.sample String
dinner.sugar Object
dinner.sugar.amount Number
dinner.sugar.sample String
snackBeforeBed Object
snackBeforeBed.time Number
snackBeforeBed.rice Object

rice or substitures
snackBeforeBed.rice.amount Number
snackBeforeBed.rice.sample String
snackBeforeBed.meat Object

meat, poultry, egg, fish, beans, or nuts
snackBeforeBed.meat.amount Number
snackBeforeBed.meat.sample String
snackBeforeBed.vegetables Object
snackBeforeBed.vegetables.amount Number
snackBeforeBed.vegetables.sample String
snackBeforeBed.fat Object

fats or oil
snackBeforeBed.fat.amount Number
snackBeforeBed.fat.sample String
snackBeforeBed.fruit Object
snackBeforeBed.fruit.amount Number
snackBeforeBed.fruit.sample String
snackBeforeBed.milk Object

milk and milk products
snackBeforeBed.milk.amount Number
snackBeforeBed.milk.sample String
snackBeforeBed.sugar Object
snackBeforeBed.sugar.amount Number
snackBeforeBed.sugar.sample String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "nutritional-plan",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

OB Note - Delete

Back to top

Delete an ob note medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ob-note
subtype String
lmp Number
fundalHeight Number
fetalHeartTone Number
examFindings String
ultrasoundDate Number
ultrasoundAog Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ob-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

OB Note - Find

Back to top

Get ob note medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=ob-note" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

ob-note
medicalRecords.subtype String
medicalRecords.lmp Number
medicalRecords.fundalHeight Number
medicalRecords.fetalHeartTone Number
medicalRecords.examFindings String
medicalRecords.ultrasoundDate Number
medicalRecords.ultrasoundAog Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
   "id": "medical-record-id",
    "type": "ob-note",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
   "id": "medical-record-id",
    "type": "ob-note",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

OB Note - Get

Back to top

Get an ob note medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ob-note
subtype String
lmp Number
fundalHeight Number
fetalHeartTone Number
examFindings String
ultrasoundDate Number
ultrasoundAog Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ob-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

OB Note - Patch

Back to top

Update an ob note medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
lmp Number optional
fundalHeight Number optional
fetalHeartTone Number optional
examFindings String optional
ultrasoundDate Number optional
ultrasoundAog Number optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "fundalHeight": 150,
    "fetalHeartTone": 150
  }'

Parameters examples

json - Request-Example

{
  "fundalHeight": 150,
  "fetalHeartTone": 150
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ob-note
subtype String
lmp Number
fundalHeight Number
fetalHeartTone Number
examFindings String
ultrasoundDate Number
ultrasoundAog Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ob-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

OB Note - Post

Back to top

Create a medical record for ob note

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: ob-note
subtype String optional
lmp Number optional
fundalHeight Number optional
fetalHeartTone Number optional
examFindings String optional
ultrasoundDate Number optional
ultrasoundAog Number optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "ob-note",
    "fundalHeight": 150,
    "fetalHeartTone": 150
  }'

Parameters examples

json - Request-Example

{
  "type": "ob-note",
  "fundalHeight": 150,
  "fetalHeartTone": 150
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ob-note
subtype String
lmp Number
fundalHeight Number
fetalHeartTone Number
examFindings String
ultrasoundDate Number
ultrasoundAog Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ob-note",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Obstetric History - Delete

Back to top

Delete an obstetric history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

obstetric-history
subtype String
LMP String
PMP String
LMPDate Number
PMPDate Number
gravidity String
parity String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "obstetric-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Obstetric History - Find

Back to top

Get obstetric history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=obstetric-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

obstetric-history
medicalRecords.subtype String
medicalRecords.LMP String
medicalRecords.PMP String
medicalRecords.LMPDate Number
medicalRecords.PMPDate Number
medicalRecords.gravidity String
medicalRecords.parity String
medicalRecords.notes String
medicalRecords.source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "obstetric-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "obstetric-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Obstetric History - Get

Back to top

Get an obstetric history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

obstetric-history
subtype String
LMP String
PMP String
LMPDate Number
PMPDate Number
gravidity String
parity String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "obstetric-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Obstetric History - Patch

Back to top

Update an obstetric history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
LMP String optional
PMP String optional
LMPDate Number optional
PMPDate Number optional
gravidity String optional
parity String optional
notes String optional
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

obstetric-history
subtype String
LMP String
PMP String
LMPDate Number
PMPDate Number
gravidity String
parity String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "obstetric-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Obstetric History - Post

Back to top

Create a medical record for obstetric history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: obstetric-history
subtype String optional
LMP String optional
PMP String optional
LMPDate Number optional
PMPDate Number optional
gravidity String optional
parity String optional
notes String optional
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "obstetric-history",
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "type": "obstetric-history",
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

obstetric-history
subtype String
LMP String
PMP String
LMPDate Number
PMPDate Number
gravidity String
parity String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "obstetric-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Pedia Milestone - Delete

Back to top

Delete an pedia milestone medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

pedia-milestone
subtype String
category String

for nesting
group String

for deeper nesting
name String

milestone name

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "pedia-milestone",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Pedia Milestone - Find

Back to top

Get pedia milestone medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=pedia-milestone" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

pedia-milestone
medicalRecords.subtype String
medicalRecords.category String

for nesting
medicalRecords.group String

for deeper nesting
medicalRecords.name String

milestone name

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "pedia-milestone",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "pedia-milestone",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Pedia Milestone - Get

Back to top

Get an pedia milestone medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

pedia-milestone
subtype String
category String

for nesting
group String

for deeper nesting
name String

milestone name

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "pedia-milestone",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Pedia Milestone - Patch

Back to top

Update an pedia milestone medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
category String optional

for nesting
group String optional

for deeper nesting
name String optional

milestone name
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "category": "some category"
  }'

Parameters examples

json - Request-Example

{
  "category": "some category"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

pedia-milestone
subtype String
category String

for nesting
group String

for deeper nesting
name String

milestone name

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "pedia-milestone",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Pedia Milestone - Post

Back to top

Create a medical record for pedia milestone

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: pedia-milestone
subtype String optional
category String optional

for nesting
group String optional

for deeper nesting
name String optional

milestone name
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "pedia-milestone",
    "category": "some category"
  }'

Parameters examples

json - Request-Example

{
  "type": "pedia-milestone",
  "category": "some category"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

pedia-milestone
subtype String
category String

for nesting
group String

for deeper nesting
name String

milestone name

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "pedia-milestone",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Physical Exam - Delete

Back to top

Delete an physical exam medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

physical-exam
subtype String
consciousnessLevel number
consciousnessLevelScale number
painAssessment number
painAssessmentScale number
physicalExam String
dentalNote String
general Object
general.text String
general.status String

normal, abnormal
head Object
head.text String
head.status String

normal, abnormal
eyes Object
eyes.text String
eyes.status String

normal, abnormal
ears Object
ears.text String
ears.status String

normal, abnormal
nose Object
nose.text String
nose.status String

normal, abnormal
neck Object
neck.text String
neck.status String

normal, abnormal
throat Object
throat.text String
throat.status String

normal, abnormal
breathSounds Object
breathSounds.text String
breathSounds.status String

normal, abnormal
respiratory Object
respiratory.text String
respiratory.status String

normal, abnormal
cardiovascular Object
cardiovascular.text String
cardiovascular.status String

normal, abnormal
breasts Object
breasts.text String
breasts.status String

normal, abnormal
chest Object
chest.text String
chest.status String

normal, abnormal
back Object
back.text String
back.status String

normal, abnormal
abdomen Object
abdomen.text String
abdomen.status String

normal, abnormal
gastrointestinal Object
gastrointestinal.text String
gastrointestinal.status String

normal, abnormal
genitourinary Object
genitourinary.text String
genitourinary.status String

normal, abnormal
musculoskeletal Object
musculoskeletal.text String
musculoskeletal.status String

normal, abnormal
skin Object
skin.text String
skin.status String

normal, abnormal
endocrine Object
endocrine.text String
endocrine.status String

normal, abnormal
psychiatric Object
psychiatric.text String
psychiatric.status String

normal, abnormal
hematologicLymphatic Object
hematologicLymphatic.text String
hematologicLymphatic.status String

normal, abnormal
allergicImmunologic Object
allergicImmunologic.text String
allergicImmunologic.status String

normal, abnormal
extermities Object
extermities.text String
extermities.status String

normal, abnormal
neurologic Object
neurologic.text String
neurologic.status String

normal, abnormal
rectal Object
rectal.text String
rectal.status String

normal, abnormal
genitalia Object
genitalia.text String
genitalia.status String

normal, abnormal
dentalExamRightUpper8 String
dentalExamRightUpper7 String
dentalExamRightUpper6 String
dentalExamRightUpper5 String
dentalExamRightUpper4 String
dentalExamRightUpper3 String
dentalExamRightUpper2 String
dentalExamRightUpper1 String
dentalExamLeftUpper8 String
dentalExamLeftUpper7 String
dentalExamLeftUpper6 String
dentalExamLeftUpper5 String
dentalExamLeftUpper4 String
dentalExamLeftUpper3 String
dentalExamLeftUpper2 String
dentalExamLeftUpper1 String
dentalExamRightLower8 String
dentalExamRightLower7 String
dentalExamRightLower6 String
dentalExamRightLower5 String
dentalExamRightLower4 String
dentalExamRightLower3 String
dentalExamRightLower2 String
dentalExamRightLower1 String
dentalExamLeftLower8 String
dentalExamLeftLower7 String
dentalExamLeftLower6 String
dentalExamLeftLower5 String
dentalExamLeftLower4 String
dentalExamLeftLower3 String
dentalExamLeftLower2 String
dentalExamLeftLower1 String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "physical-exam",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Physical Exam - Find

Back to top

Get physical exam medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=physical-exam" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

physical-exam
medicalRecords.subtype String
medicalRecords.consciousnessLevel number
medicalRecords.consciousnessLevelScale number
medicalRecords.painAssessment number
medicalRecords.painAssessmentScale number
medicalRecords.physicalExam String
medicalRecords.dentalNote String
medicalRecords.general Object
medicalRecords.general.text String
medicalRecords.general.status String

normal, abnormal
medicalRecords.head Object
medicalRecords.head.text String
medicalRecords.head.status String

normal, abnormal
medicalRecords.eyes Object
medicalRecords.eyes.text String
medicalRecords.eyes.status String

normal, abnormal
medicalRecords.ears Object
medicalRecords.ears.text String
medicalRecords.ears.status String

normal, abnormal
medicalRecords.nose Object
medicalRecords.nose.text String
medicalRecords.nose.status String

normal, abnormal
medicalRecords.neck Object
medicalRecords.neck.text String
medicalRecords.neck.status String

normal, abnormal
medicalRecords.throat Object
medicalRecords.throat.text String
medicalRecords.throat.status String

normal, abnormal
medicalRecords.breathSounds Object
medicalRecords.breathSounds.text String
medicalRecords.breathSounds.status String

normal, abnormal
medicalRecords.respiratory Object
medicalRecords.respiratory.text String
medicalRecords.respiratory.status String

normal, abnormal
medicalRecords.cardiovascular Object
medicalRecords.cardiovascular.text String
medicalRecords.cardiovascular.status String

normal, abnormal
medicalRecords.breasts Object
medicalRecords.breasts.text String
medicalRecords.breasts.status String

normal, abnormal
medicalRecords.chest Object
medicalRecords.chest.text String
medicalRecords.chest.status String

normal, abnormal
medicalRecords.back Object
medicalRecords.back.text String
medicalRecords.back.status String

normal, abnormal
medicalRecords.abdomen Object
medicalRecords.abdomen.text String
medicalRecords.abdomen.status String

normal, abnormal
medicalRecords.gastrointestinal Object
medicalRecords.gastrointestinal.text String
medicalRecords.gastrointestinal.status String

normal, abnormal
medicalRecords.genitourinary Object
medicalRecords.genitourinary.text String
medicalRecords.genitourinary.status String

normal, abnormal
medicalRecords.musculoskeletal Object
medicalRecords.musculoskeletal.text String
medicalRecords.musculoskeletal.status String

normal, abnormal
medicalRecords.skin Object
medicalRecords.skin.text String
medicalRecords.skin.status String

normal, abnormal
medicalRecords.endocrine Object
medicalRecords.endocrine.text String
medicalRecords.endocrine.status String

normal, abnormal
medicalRecords.psychiatric Object
medicalRecords.psychiatric.text String
medicalRecords.psychiatric.status String

normal, abnormal
medicalRecords.hematologicLymphatic Object
medicalRecords.hematologicLymphatic.text String
medicalRecords.hematologicLymphatic.status String

normal, abnormal
medicalRecords.allergicImmunologic Object
medicalRecords.allergicImmunologic.text String
medicalRecords.allergicImmunologic.status String

normal, abnormal
medicalRecords.extermities Object
medicalRecords.extermities.text String
medicalRecords.extermities.status String

normal, abnormal
medicalRecords.neurologic Object
medicalRecords.neurologic.text String
medicalRecords.neurologic.status String

normal, abnormal
medicalRecords.rectal Object
medicalRecords.rectal.text String
medicalRecords.rectal.status String

normal, abnormal
medicalRecords.genitalia Object
medicalRecords.genitalia.text String
medicalRecords.genitalia.status String

normal, abnormal
medicalRecords.dentalExamRightUpper8 String
medicalRecords.dentalExamRightUpper7 String
medicalRecords.dentalExamRightUpper6 String
medicalRecords.dentalExamRightUpper5 String
medicalRecords.dentalExamRightUpper4 String
medicalRecords.dentalExamRightUpper3 String
medicalRecords.dentalExamRightUpper2 String
medicalRecords.dentalExamRightUpper1 String
medicalRecords.dentalExamLeftUpper8 String
medicalRecords.dentalExamLeftUpper7 String
medicalRecords.dentalExamLeftUpper6 String
medicalRecords.dentalExamLeftUpper5 String
medicalRecords.dentalExamLeftUpper4 String
medicalRecords.dentalExamLeftUpper3 String
medicalRecords.dentalExamLeftUpper2 String
medicalRecords.dentalExamLeftUpper1 String
medicalRecords.dentalExamRightLower8 String
medicalRecords.dentalExamRightLower7 String
medicalRecords.dentalExamRightLower6 String
medicalRecords.dentalExamRightLower5 String
medicalRecords.dentalExamRightLower4 String
medicalRecords.dentalExamRightLower3 String
medicalRecords.dentalExamRightLower2 String
medicalRecords.dentalExamRightLower1 String
medicalRecords.dentalExamLeftLower8 String
medicalRecords.dentalExamLeftLower7 String
medicalRecords.dentalExamLeftLower6 String
medicalRecords.dentalExamLeftLower5 String
medicalRecords.dentalExamLeftLower4 String
medicalRecords.dentalExamLeftLower3 String
medicalRecords.dentalExamLeftLower2 String
medicalRecords.dentalExamLeftLower1 String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "physical-exam",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "physical-exam",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Physical Exam - Get

Back to top

Get an physical exam medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

physical-exam
subtype String
consciousnessLevel number
consciousnessLevelScale number
painAssessment number
painAssessmentScale number
physicalExam String
dentalNote String
general Object
general.text String
general.status String

normal, abnormal
head Object
head.text String
head.status String

normal, abnormal
eyes Object
eyes.text String
eyes.status String

normal, abnormal
ears Object
ears.text String
ears.status String

normal, abnormal
nose Object
nose.text String
nose.status String

normal, abnormal
neck Object
neck.text String
neck.status String

normal, abnormal
throat Object
throat.text String
throat.status String

normal, abnormal
breathSounds Object
breathSounds.text String
breathSounds.status String

normal, abnormal
respiratory Object
respiratory.text String
respiratory.status String

normal, abnormal
cardiovascular Object
cardiovascular.text String
cardiovascular.status String

normal, abnormal
breasts Object
breasts.text String
breasts.status String

normal, abnormal
chest Object
chest.text String
chest.status String

normal, abnormal
back Object
back.text String
back.status String

normal, abnormal
abdomen Object
abdomen.text String
abdomen.status String

normal, abnormal
gastrointestinal Object
gastrointestinal.text String
gastrointestinal.status String

normal, abnormal
genitourinary Object
genitourinary.text String
genitourinary.status String

normal, abnormal
musculoskeletal Object
musculoskeletal.text String
musculoskeletal.status String

normal, abnormal
skin Object
skin.text String
skin.status String

normal, abnormal
endocrine Object
endocrine.text String
endocrine.status String

normal, abnormal
psychiatric Object
psychiatric.text String
psychiatric.status String

normal, abnormal
hematologicLymphatic Object
hematologicLymphatic.text String
hematologicLymphatic.status String

normal, abnormal
allergicImmunologic Object
allergicImmunologic.text String
allergicImmunologic.status String

normal, abnormal
extermities Object
extermities.text String
extermities.status String

normal, abnormal
neurologic Object
neurologic.text String
neurologic.status String

normal, abnormal
rectal Object
rectal.text String
rectal.status String

normal, abnormal
genitalia Object
genitalia.text String
genitalia.status String

normal, abnormal
dentalExamRightUpper8 String
dentalExamRightUpper7 String
dentalExamRightUpper6 String
dentalExamRightUpper5 String
dentalExamRightUpper4 String
dentalExamRightUpper3 String
dentalExamRightUpper2 String
dentalExamRightUpper1 String
dentalExamLeftUpper8 String
dentalExamLeftUpper7 String
dentalExamLeftUpper6 String
dentalExamLeftUpper5 String
dentalExamLeftUpper4 String
dentalExamLeftUpper3 String
dentalExamLeftUpper2 String
dentalExamLeftUpper1 String
dentalExamRightLower8 String
dentalExamRightLower7 String
dentalExamRightLower6 String
dentalExamRightLower5 String
dentalExamRightLower4 String
dentalExamRightLower3 String
dentalExamRightLower2 String
dentalExamRightLower1 String
dentalExamLeftLower8 String
dentalExamLeftLower7 String
dentalExamLeftLower6 String
dentalExamLeftLower5 String
dentalExamLeftLower4 String
dentalExamLeftLower3 String
dentalExamLeftLower2 String
dentalExamLeftLower1 String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "physical-exam",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Physical Exam - Patch

Back to top

Update an physical exam medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
consciousnessLevel number optional
consciousnessLevelScale number optional
painAssessment number optional
painAssessmentScale number optional
physicalExam String optional
dentalNote String optional
general Object optional
general.text String
general.status String Allowed values: normal,abnormal
head Object optional
head.text String
head.status String Allowed values: normal,abnormal
eyes Object optional
eyes.text String
eyes.status String Allowed values: normal,abnormal
ears Object optional
ears.text String
ears.status String Allowed values: normal,abnormal
nose Object optional
nose.text String
nose.status String Allowed values: normal,abnormal
neck Object optional
neck.text String
neck.status String Allowed values: normal,abnormal
throat Object optional
throat.text String
throat.status String Allowed values: normal,abnormal
breathSounds Object optional
breathSounds.text String
breathSounds.status String Allowed values: normal,abnormal
respiratory Object optional
respiratory.text String
respiratory.status String Allowed values: normal,abnormal
cardiovascular Object optional
cardiovascular.text String
cardiovascular.status String Allowed values: normal,abnormal
breasts Object optional
breasts.text String
breasts.status String Allowed values: normal,abnormal
chest Object optional
chest.text String
chest.status String Allowed values: normal,abnormal
back Object optional
back.text String
back.status String Allowed values: normal,abnormal
abdomen Object optional
abdomen.text String
abdomen.status String Allowed values: normal,abnormal
gastrointestinal Object optional
gastrointestinal.text String
gastrointestinal.status String Allowed values: normal,abnormal
genitourinary Object optional
genitourinary.text String
genitourinary.status String Allowed values: normal,abnormal
musculoskeletal Object optional
musculoskeletal.text String
musculoskeletal.status String Allowed values: normal,abnormal
skin Object optional
skin.text String
skin.status String Allowed values: normal,abnormal
endocrine Object optional
endocrine.text String
endocrine.status String Allowed values: normal,abnormal
psychiatric Object optional
psychiatric.text String
psychiatric.status String Allowed values: normal,abnormal
hematologicLymphatic Object optional
hematologicLymphatic.text String
hematologicLymphatic.status String Allowed values: normal,abnormal
allergicImmunologic Object optional
allergicImmunologic.text String
allergicImmunologic.status String Allowed values: normal,abnormal
extermities Object optional
extermities.text String
extermities.status String Allowed values: normal,abnormal
neurologic Object optional
neurologic.text String
neurologic.status String Allowed values: normal,abnormal
rectal Object optional
rectal.text String
rectal.status String Allowed values: normal,abnormal
genitalia Object optional
genitalia.text String
genitalia.status String Allowed values: normal,abnormal
dentalExamRightUpper8 String optional
dentalExamRightUpper7 String optional
dentalExamRightUpper6 String optional
dentalExamRightUpper5 String optional
dentalExamRightUpper4 String optional
dentalExamRightUpper3 String optional
dentalExamRightUpper2 String optional
dentalExamRightUpper1 String optional
dentalExamLeftUpper8 String optional
dentalExamLeftUpper7 String optional
dentalExamLeftUpper6 String optional
dentalExamLeftUpper5 String optional
dentalExamLeftUpper4 String optional
dentalExamLeftUpper3 String optional
dentalExamLeftUpper2 String optional
dentalExamLeftUpper1 String optional
dentalExamRightLower8 String optional
dentalExamRightLower7 String optional
dentalExamRightLower6 String optional
dentalExamRightLower5 String optional
dentalExamRightLower4 String optional
dentalExamRightLower3 String optional
dentalExamRightLower2 String optional
dentalExamRightLower1 String optional
dentalExamLeftLower8 String optional
dentalExamLeftLower7 String optional
dentalExamLeftLower6 String optional
dentalExamLeftLower5 String optional
dentalExamLeftLower4 String optional
dentalExamLeftLower3 String optional
dentalExamLeftLower2 String optional
dentalExamLeftLower1 String optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "dentalExamRightUpper8": "some dentalExamRightUpper8"
  }'

Parameters examples

json - Request-Example

{
  "dentalExamRightUpper8": "some dentalExamRightUpper8"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

physical-exam
subtype String
consciousnessLevel number
consciousnessLevelScale number
painAssessment number
painAssessmentScale number
physicalExam String
dentalNote String
general Object
general.text String
general.status String

normal, abnormal
head Object
head.text String
head.status String

normal, abnormal
eyes Object
eyes.text String
eyes.status String

normal, abnormal
ears Object
ears.text String
ears.status String

normal, abnormal
nose Object
nose.text String
nose.status String

normal, abnormal
neck Object
neck.text String
neck.status String

normal, abnormal
throat Object
throat.text String
throat.status String

normal, abnormal
breathSounds Object
breathSounds.text String
breathSounds.status String

normal, abnormal
respiratory Object
respiratory.text String
respiratory.status String

normal, abnormal
cardiovascular Object
cardiovascular.text String
cardiovascular.status String

normal, abnormal
breasts Object
breasts.text String
breasts.status String

normal, abnormal
chest Object
chest.text String
chest.status String

normal, abnormal
back Object
back.text String
back.status String

normal, abnormal
abdomen Object
abdomen.text String
abdomen.status String

normal, abnormal
gastrointestinal Object
gastrointestinal.text String
gastrointestinal.status String

normal, abnormal
genitourinary Object
genitourinary.text String
genitourinary.status String

normal, abnormal
musculoskeletal Object
musculoskeletal.text String
musculoskeletal.status String

normal, abnormal
skin Object
skin.text String
skin.status String

normal, abnormal
endocrine Object
endocrine.text String
endocrine.status String

normal, abnormal
psychiatric Object
psychiatric.text String
psychiatric.status String

normal, abnormal
hematologicLymphatic Object
hematologicLymphatic.text String
hematologicLymphatic.status String

normal, abnormal
allergicImmunologic Object
allergicImmunologic.text String
allergicImmunologic.status String

normal, abnormal
extermities Object
extermities.text String
extermities.status String

normal, abnormal
neurologic Object
neurologic.text String
neurologic.status String

normal, abnormal
rectal Object
rectal.text String
rectal.status String

normal, abnormal
genitalia Object
genitalia.text String
genitalia.status String

normal, abnormal
dentalExamRightUpper8 String
dentalExamRightUpper7 String
dentalExamRightUpper6 String
dentalExamRightUpper5 String
dentalExamRightUpper4 String
dentalExamRightUpper3 String
dentalExamRightUpper2 String
dentalExamRightUpper1 String
dentalExamLeftUpper8 String
dentalExamLeftUpper7 String
dentalExamLeftUpper6 String
dentalExamLeftUpper5 String
dentalExamLeftUpper4 String
dentalExamLeftUpper3 String
dentalExamLeftUpper2 String
dentalExamLeftUpper1 String
dentalExamRightLower8 String
dentalExamRightLower7 String
dentalExamRightLower6 String
dentalExamRightLower5 String
dentalExamRightLower4 String
dentalExamRightLower3 String
dentalExamRightLower2 String
dentalExamRightLower1 String
dentalExamLeftLower8 String
dentalExamLeftLower7 String
dentalExamLeftLower6 String
dentalExamLeftLower5 String
dentalExamLeftLower4 String
dentalExamLeftLower3 String
dentalExamLeftLower2 String
dentalExamLeftLower1 String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "physical-exam",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Physical Exam - Post

Back to top

Create a medical record for physical exam

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: physical-exam
subtype String optional
consciousnessLevel number optional
consciousnessLevelScale number optional
painAssessment number optional
painAssessmentScale number optional
physicalExam String optional
dentalNote String optional
general Object optional
general.text String
general.status String Allowed values: normal,abnormal
head Object optional
head.text String
head.status String Allowed values: normal,abnormal
eyes Object optional
eyes.text String
eyes.status String Allowed values: normal,abnormal
ears Object optional
ears.text String
ears.status String Allowed values: normal,abnormal
nose Object optional
nose.text String
nose.status String Allowed values: normal,abnormal
neck Object optional
neck.text String
neck.status String Allowed values: normal,abnormal
throat Object optional
throat.text String
throat.status String Allowed values: normal,abnormal
breathSounds Object optional
breathSounds.text String
breathSounds.status String Allowed values: normal,abnormal
respiratory Object optional
respiratory.text String
respiratory.status String Allowed values: normal,abnormal
cardiovascular Object optional
cardiovascular.text String
cardiovascular.status String Allowed values: normal,abnormal
breasts Object optional
breasts.text String
breasts.status String Allowed values: normal,abnormal
chest Object optional
chest.text String
chest.status String Allowed values: normal,abnormal
back Object optional
back.text String
back.status String Allowed values: normal,abnormal
abdomen Object optional
abdomen.text String
abdomen.status String Allowed values: normal,abnormal
gastrointestinal Object optional
gastrointestinal.text String
gastrointestinal.status String Allowed values: normal,abnormal
genitourinary Object optional
genitourinary.text String
genitourinary.status String Allowed values: normal,abnormal
musculoskeletal Object optional
musculoskeletal.text String
musculoskeletal.status String Allowed values: normal,abnormal
skin Object optional
skin.text String
skin.status String Allowed values: normal,abnormal
endocrine Object optional
endocrine.text String
endocrine.status String Allowed values: normal,abnormal
psychiatric Object optional
psychiatric.text String
psychiatric.status String Allowed values: normal,abnormal
hematologicLymphatic Object optional
hematologicLymphatic.text String
hematologicLymphatic.status String Allowed values: normal,abnormal
allergicImmunologic Object optional
allergicImmunologic.text String
allergicImmunologic.status String Allowed values: normal,abnormal
extermities Object optional
extermities.text String
extermities.status String Allowed values: normal,abnormal
neurologic Object optional
neurologic.text String
neurologic.status String Allowed values: normal,abnormal
rectal Object optional
rectal.text String
rectal.status String Allowed values: normal,abnormal
genitalia Object optional
genitalia.text String
genitalia.status String Allowed values: normal,abnormal
dentalExamRightUpper8 String optional
dentalExamRightUpper7 String optional
dentalExamRightUpper6 String optional
dentalExamRightUpper5 String optional
dentalExamRightUpper4 String optional
dentalExamRightUpper3 String optional
dentalExamRightUpper2 String optional
dentalExamRightUpper1 String optional
dentalExamLeftUpper8 String optional
dentalExamLeftUpper7 String optional
dentalExamLeftUpper6 String optional
dentalExamLeftUpper5 String optional
dentalExamLeftUpper4 String optional
dentalExamLeftUpper3 String optional
dentalExamLeftUpper2 String optional
dentalExamLeftUpper1 String optional
dentalExamRightLower8 String optional
dentalExamRightLower7 String optional
dentalExamRightLower6 String optional
dentalExamRightLower5 String optional
dentalExamRightLower4 String optional
dentalExamRightLower3 String optional
dentalExamRightLower2 String optional
dentalExamRightLower1 String optional
dentalExamLeftLower8 String optional
dentalExamLeftLower7 String optional
dentalExamLeftLower6 String optional
dentalExamLeftLower5 String optional
dentalExamLeftLower4 String optional
dentalExamLeftLower3 String optional
dentalExamLeftLower2 String optional
dentalExamLeftLower1 String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "physical-exam",
    "dentalExamRightUpper8": "some dentalExamRightUpper8"
  }'

Parameters examples

json - Request-Example

{
  "type": "physical-exam",
  "dentalExamRightUpper8": "some dentalExamRightUpper8"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

physical-exam
subtype String
consciousnessLevel number
consciousnessLevelScale number
painAssessment number
painAssessmentScale number
physicalExam String
dentalNote String
general Object
general.text String
general.status String

normal, abnormal
head Object
head.text String
head.status String

normal, abnormal
eyes Object
eyes.text String
eyes.status String

normal, abnormal
ears Object
ears.text String
ears.status String

normal, abnormal
nose Object
nose.text String
nose.status String

normal, abnormal
neck Object
neck.text String
neck.status String

normal, abnormal
throat Object
throat.text String
throat.status String

normal, abnormal
breathSounds Object
breathSounds.text String
breathSounds.status String

normal, abnormal
respiratory Object
respiratory.text String
respiratory.status String

normal, abnormal
cardiovascular Object
cardiovascular.text String
cardiovascular.status String

normal, abnormal
breasts Object
breasts.text String
breasts.status String

normal, abnormal
chest Object
chest.text String
chest.status String

normal, abnormal
back Object
back.text String
back.status String

normal, abnormal
abdomen Object
abdomen.text String
abdomen.status String

normal, abnormal
gastrointestinal Object
gastrointestinal.text String
gastrointestinal.status String

normal, abnormal
genitourinary Object
genitourinary.text String
genitourinary.status String

normal, abnormal
musculoskeletal Object
musculoskeletal.text String
musculoskeletal.status String

normal, abnormal
skin Object
skin.text String
skin.status String

normal, abnormal
endocrine Object
endocrine.text String
endocrine.status String

normal, abnormal
psychiatric Object
psychiatric.text String
psychiatric.status String

normal, abnormal
hematologicLymphatic Object
hematologicLymphatic.text String
hematologicLymphatic.status String

normal, abnormal
allergicImmunologic Object
allergicImmunologic.text String
allergicImmunologic.status String

normal, abnormal
extermities Object
extermities.text String
extermities.status String

normal, abnormal
neurologic Object
neurologic.text String
neurologic.status String

normal, abnormal
rectal Object
rectal.text String
rectal.status String

normal, abnormal
genitalia Object
genitalia.text String
genitalia.status String

normal, abnormal
dentalExamRightUpper8 String
dentalExamRightUpper7 String
dentalExamRightUpper6 String
dentalExamRightUpper5 String
dentalExamRightUpper4 String
dentalExamRightUpper3 String
dentalExamRightUpper2 String
dentalExamRightUpper1 String
dentalExamLeftUpper8 String
dentalExamLeftUpper7 String
dentalExamLeftUpper6 String
dentalExamLeftUpper5 String
dentalExamLeftUpper4 String
dentalExamLeftUpper3 String
dentalExamLeftUpper2 String
dentalExamLeftUpper1 String
dentalExamRightLower8 String
dentalExamRightLower7 String
dentalExamRightLower6 String
dentalExamRightLower5 String
dentalExamRightLower4 String
dentalExamRightLower3 String
dentalExamRightLower2 String
dentalExamRightLower1 String
dentalExamLeftLower8 String
dentalExamLeftLower7 String
dentalExamLeftLower6 String
dentalExamLeftLower5 String
dentalExamLeftLower4 String
dentalExamLeftLower3 String
dentalExamLeftLower2 String
dentalExamLeftLower1 String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "physical-exam",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

ROS - Delete

Back to top

Delete an ros medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ros
subtype String
general String

or constitutional
eyes String
ent String

ears, nose, mouth, and throat
cardiovascular String
respiratory String
gastrointestinal String
genitourinary String
musculoskeletal String
breasts String
skin String
neurologic String
psychiatric String
endocrine String
hematologicLymphatic String
allergicImmunologic String
neck String
peripheralVascular String
notes String
generalStatus String
eyesStatus String
entStatus String
cardiovascularStatus String
respiratoryStatus String
gastrointestinalStatus String
genitourinaryStatus String
musculoskeletalStatus String
breastsStatus String
skinStatus String
neurologicStatus String
psychiatricStatus String
endocrineStatus String
hematologicLymphaticStatus String
allergicImmunologicStatus String
neckStatus String
peripheralVascularStatus String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ros",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

ROS - Find

Back to top

Get ros medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=ros" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

ros
medicalRecords.subtype String
medicalRecords.general String

or constitutional
medicalRecords.eyes String
medicalRecords.ent String

ears, nose, mouth, and throat
medicalRecords.cardiovascular String
medicalRecords.respiratory String
medicalRecords.gastrointestinal String
medicalRecords.genitourinary String
medicalRecords.musculoskeletal String
medicalRecords.breasts String
medicalRecords.skin String
medicalRecords.neurologic String
medicalRecords.psychiatric String
medicalRecords.endocrine String
medicalRecords.hematologicLymphatic String
medicalRecords.allergicImmunologic String
medicalRecords.neck String
medicalRecords.peripheralVascular String
medicalRecords.notes String
medicalRecords.generalStatus String
medicalRecords.eyesStatus String
medicalRecords.entStatus String
medicalRecords.cardiovascularStatus String
medicalRecords.respiratoryStatus String
medicalRecords.gastrointestinalStatus String
medicalRecords.genitourinaryStatus String
medicalRecords.musculoskeletalStatus String
medicalRecords.breastsStatus String
medicalRecords.skinStatus String
medicalRecords.neurologicStatus String
medicalRecords.psychiatricStatus String
medicalRecords.endocrineStatus String
medicalRecords.hematologicLymphaticStatus String
medicalRecords.allergicImmunologicStatus String
medicalRecords.neckStatus String
medicalRecords.peripheralVascularStatus String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "ros",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "ros",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

ROS - Get

Back to top

Get an ros medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ros
subtype String
general String

or constitutional
eyes String
ent String

ears, nose, mouth, and throat
cardiovascular String
respiratory String
gastrointestinal String
genitourinary String
musculoskeletal String
breasts String
skin String
neurologic String
psychiatric String
endocrine String
hematologicLymphatic String
allergicImmunologic String
neck String
peripheralVascular String
notes String
generalStatus String
eyesStatus String
entStatus String
cardiovascularStatus String
respiratoryStatus String
gastrointestinalStatus String
genitourinaryStatus String
musculoskeletalStatus String
breastsStatus String
skinStatus String
neurologicStatus String
psychiatricStatus String
endocrineStatus String
hematologicLymphaticStatus String
allergicImmunologicStatus String
neckStatus String
peripheralVascularStatus String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ros",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

ROS - Patch

Back to top

Update an ros medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
general String optional

or constitutional
eyes String optional
ent String optional

ears, nose, mouth, and throat
cardiovascular String optional
respiratory String optional
gastrointestinal String optional
genitourinary String optional
musculoskeletal String optional
breasts String optional
skin String optional
neurologic String optional
psychiatric String optional
endocrine String optional
hematologicLymphatic String optional
allergicImmunologic String optional
neck String optional
peripheralVascular String optional
notes String optional
generalStatus String optional
eyesStatus String optional
entStatus String optional
cardiovascularStatus String optional
respiratoryStatus String optional
gastrointestinalStatus String optional
genitourinaryStatus String optional
musculoskeletalStatus String optional
breastsStatus String optional
skinStatus String optional
neurologicStatus String optional
psychiatricStatus String optional
endocrineStatus String optional
hematologicLymphaticStatus String optional
allergicImmunologicStatus String optional
neckStatus String optional
peripheralVascularStatus String optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "cardiovascular": "some cardiovascular",
    "genitourinary": "some genitourinary"
  }'

Parameters examples

json - Request-Example

{
  "cardiovascular": "some cardiovascular",
  "genitourinary": "some genitourinary"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ros
subtype String
general String

or constitutional
eyes String
ent String

ears, nose, mouth, and throat
cardiovascular String
respiratory String
gastrointestinal String
genitourinary String
musculoskeletal String
breasts String
skin String
neurologic String
psychiatric String
endocrine String
hematologicLymphatic String
allergicImmunologic String
neck String
peripheralVascular String
notes String
generalStatus String
eyesStatus String
entStatus String
cardiovascularStatus String
respiratoryStatus String
gastrointestinalStatus String
genitourinaryStatus String
musculoskeletalStatus String
breastsStatus String
skinStatus String
neurologicStatus String
psychiatricStatus String
endocrineStatus String
hematologicLymphaticStatus String
allergicImmunologicStatus String
neckStatus String
peripheralVascularStatus String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ros",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

ROS - Post

Back to top

Create a medical record for ros

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: ros
general String optional

or constitutional
eyes String optional
ent String optional

ears, nose, mouth, and throat
cardiovascular String optional
respiratory String optional
gastrointestinal String optional
genitourinary String optional
musculoskeletal String optional
breasts String optional
skin String optional
neurologic String optional
psychiatric String optional
endocrine String optional
hematologicLymphatic String optional
allergicImmunologic String optional
neck String optional
peripheralVascular String optional
notes String optional
generalStatus String optional
eyesStatus String optional
entStatus String optional
cardiovascularStatus String optional
respiratoryStatus String optional
gastrointestinalStatus String optional
genitourinaryStatus String optional
musculoskeletalStatus String optional
breastsStatus String optional
skinStatus String optional
neurologicStatus String optional
psychiatricStatus String optional
endocrineStatus String optional
hematologicLymphaticStatus String optional
allergicImmunologicStatus String optional
neckStatus String optional
peripheralVascularStatus String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "ros",
    "cardiovascular": "some cardiovascular",
    "genitourinary": "some genitourinary"
  }'

Parameters examples

json - Request-Example

{
  "type": "ros",
  "cardiovascular": "some cardiovascular",
  "genitourinary": "some genitourinary"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

ros
subtype String
general String

or constitutional
eyes String
ent String

ears, nose, mouth, and throat
cardiovascular String
respiratory String
gastrointestinal String
genitourinary String
musculoskeletal String
breasts String
skin String
neurologic String
psychiatric String
endocrine String
hematologicLymphatic String
allergicImmunologic String
neck String
peripheralVascular String
notes String
generalStatus String
eyesStatus String
entStatus String
cardiovascularStatus String
respiratoryStatus String
gastrointestinalStatus String
genitourinaryStatus String
musculoskeletalStatus String
breastsStatus String
skinStatus String
neurologicStatus String
psychiatricStatus String
endocrineStatus String
hematologicLymphaticStatus String
allergicImmunologicStatus String
neckStatus String
peripheralVascularStatus String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "ros",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Social History - Delete

Back to top

Delete a social history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

social-history
subtype String
livesAlone Boolean
independent Boolean
drinksAlcohol Boolean

drinks alcohol
smoking Boolean
smokingSticksPerDay Number

number of sticks per day if smoking
smokingYears Number

number of years patient is smoking
exercises Boolean
usesProhibitedDrugs Boolean

uses prohibited drugs
drugName String
drugLastUsedAt Number
sexuallyActive Boolean
numOfSexualPartners Number
educationalLevel String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "social-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Social History - Find

Back to top

Get social history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=social-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

social-history
medicalRecords.subtype String
medicalRecords.livesAlone Boolean
medicalRecords.independent Boolean
medicalRecords.drinksAlcohol Boolean

drinks alcohol
medicalRecords.smoking Boolean
medicalRecords.smokingSticksPerDay Number

number of sticks per day if smoking
medicalRecords.smokingYears Number

number of years patient is smoking
medicalRecords.exercises Boolean
medicalRecords.usesProhibitedDrugs Boolean

uses prohibited drugs
medicalRecords.drugName String
medicalRecords.drugLastUsedAt Number
medicalRecords.sexuallyActive Boolean
medicalRecords.numOfSexualPartners Number
medicalRecords.educationalLevel String
medicalRecords.notes String
medicalRecords.source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "social-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "social-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Social History - Get

Back to top

Get a social history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

social-history
subtype String
livesAlone Boolean
independent Boolean
drinksAlcohol Boolean

drinks alcohol
smoking Boolean
smokingSticksPerDay Number

number of sticks per day if smoking
smokingYears Number

number of years patient is smoking
exercises Boolean
usesProhibitedDrugs Boolean

uses prohibited drugs
drugName String
drugLastUsedAt Number
sexuallyActive Boolean
numOfSexualPartners Number
educationalLevel String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "social-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Social History - Patch

Back to top

Update a social history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
livesAlone Boolean optional
independent Boolean optional
drinksAlcohol Boolean optional

drinks alcohol
smoking Boolean optional
smokingSticksPerDay Number optional

number of sticks per day if smoking
smokingYears Number optional

number of years patient is smoking
exercises Boolean optional
usesProhibitedDrugs Boolean optional

uses prohibited drugs
drugName String optional
drugLastUsedAt Number optional
sexuallyActive Boolean optional
numOfSexualPartners Number optional
educationalLevel String optional
notes String optional
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

social-history
subtype String
livesAlone Boolean
independent Boolean
drinksAlcohol Boolean

drinks alcohol
smoking Boolean
smokingSticksPerDay Number

number of sticks per day if smoking
smokingYears Number

number of years patient is smoking
exercises Boolean
usesProhibitedDrugs Boolean

uses prohibited drugs
drugName String
drugLastUsedAt Number
sexuallyActive Boolean
numOfSexualPartners Number
educationalLevel String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "social-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Social History - Post

Back to top

Create a medical record for social history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: social-history
subtype String optional
livesAlone Boolean optional
independent Boolean optional
drinksAlcohol Boolean optional

drinks alcohol
smoking Boolean optional
smokingSticksPerDay Number optional

number of sticks per day if smoking
smokingYears Number optional

number of years patient is smoking
exercises Boolean optional
usesProhibitedDrugs Boolean optional

uses prohibited drugs
drugName String optional
drugLastUsedAt Number optional
sexuallyActive Boolean optional
numOfSexualPartners Number optional
educationalLevel String optional
notes String optional
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "social-history",
    "notes": "some notes",
    "source": "some source"
  }'

Parameters examples

json - Request-Example

{
  "type": "social-history",
  "notes": "some notes",
  "source": "some source"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

social-history
subtype String
livesAlone Boolean
independent Boolean
drinksAlcohol Boolean

drinks alcohol
smoking Boolean
smokingSticksPerDay Number

number of sticks per day if smoking
smokingYears Number

number of years patient is smoking
exercises Boolean
usesProhibitedDrugs Boolean

uses prohibited drugs
drugName String
drugLastUsedAt Number
sexuallyActive Boolean
numOfSexualPartners Number
educationalLevel String
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "social-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Surgical History - Delete

Back to top

Delete a surgical history medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

surgical-history
subtype String
hospitalName String
procedure String
performedAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "surgical-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Surgical History - Find

Back to top

Get surgical history medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=surgical-history" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

surgical-history
medicalRecords.subtype String
medicalRecords.hospitalName String
medicalRecords.procedure String
medicalRecords.performedAt Number
medicalRecords.notes String
medicalRecords.source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "surgical-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "surgical-history",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Surgical History - Get

Back to top

Get a surgical history medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

surgical-history
subtype String
hospitalName String
procedure String
performedAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "surgical-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Surgical History - Patch

Back to top

Update a surgical history medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
hospitalName String optional
procedure String optional
performedAt Number optional
notes String optional
source String optional

who provided the details
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "methodOfDelivery": "some methodOfDelivery",
    "complications": "some complications"
  }'

Parameters examples

json - Request-Example

{
  "methodOfDelivery": "some methodOfDelivery",
  "complications": "some complications"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

surgical-history
subtype String
hospitalName String
procedure String
performedAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "surgical-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Surgical History - Post

Back to top

Create a medical record for surgical history

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: surgical-history
subtype String optional
hospitalName String optional
procedure String optional
performedAt Number optional
notes String optional
source String optional

who provided the details
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "surgical-history",
    "methodOfDelivery": "some methodOfDelivery",
    "complications": "some complications"
  }'

Parameters examples

json - Request-Example

{
  "type": "surgical-history",
  "methodOfDelivery": "some methodOfDelivery",
  "complications": "some complications"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

surgical-history
subtype String
hospitalName String
procedure String
performedAt Number
notes String
source String

who provided the details

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "surgical-history",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Treadmill Stress Test Patient Profile - Delete

Back to top

Delete an treadmill stress test patient profile medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

treadmill-stress-test-patient-profile
subtype String
order String

medical-procedure-order reference id
symptoms String
none String
angina String
priorMI Boolean
priorMILocation String
priorCorAngio Boolean
priorCorAngioWhenOrResults String
priorBypass Boolean
priorBypassWhenOrResults String
priorPTCA Boolean
priorPTCADuration String
hypertension Boolean
hypertensionDuration String
diabetesMellitus Boolean
diabetesMellitusDuration String
hyperlipidemia Boolean
hyperlipidemiaValue String
tobaccoHistory Boolean
tobaccoPackPerYear String
familyHistoryOfMI Boolean
familyHistoryOfMIFirstDegreeRelation String
valvularDxHistory Boolean
valvularDxHistoryValueLesion String
CHFHistory Boolean
medicationsMap Object
medicationsMap.betaBlocker Boolean
medicationsMap.betaBlockerNotes String
medicationsMap.calciumChannelBlocker Boolean
medicationsMap.calciumChannelBlockerNotes String
medicationsMap.nitrates Boolean
medicationsMap.nitratesNotes String
medicationsMap.ACEInhibitor Boolean
medicationsMap.ACEInhibitorNotes String
medicationsMap.digoxin Boolean
medicationsMap.digoxinNotes String
medicationsMap.others Boolean
medicationsMap.othersNotes String
comments String
attendingPhysician String

account uid of the doctor

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "treadmill-stress-test-patient-profile",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Treadmill Stress Test Patient Profile - Find

Back to top

Get treadmill stress test patient profile medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=treadmill-stress-test-patient-profile" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

treadmill-stress-test-patient-profile
medicalRecords.subtype String
medicalRecords.order String

medical-procedure-order reference id
medicalRecords.symptoms String
medicalRecords.none String
medicalRecords.angina String
medicalRecords.priorMI Boolean
medicalRecords.priorMILocation String
medicalRecords.priorCorAngio Boolean
medicalRecords.priorCorAngioWhenOrResults String
medicalRecords.priorBypass Boolean
medicalRecords.priorBypassWhenOrResults String
medicalRecords.priorPTCA Boolean
medicalRecords.priorPTCADuration String
medicalRecords.hypertension Boolean
medicalRecords.hypertensionDuration String
medicalRecords.diabetesMellitus Boolean
medicalRecords.diabetesMellitusDuration String
medicalRecords.hyperlipidemia Boolean
medicalRecords.hyperlipidemiaValue String
medicalRecords.tobaccoHistory Boolean
medicalRecords.tobaccoPackPerYear String
medicalRecords.familyHistoryOfMI Boolean
medicalRecords.familyHistoryOfMIFirstDegreeRelation String
medicalRecords.valvularDxHistory Boolean
medicalRecords.valvularDxHistoryValueLesion String
medicalRecords.CHFHistory Boolean
medicalRecords.medicationsMap Object
medicalRecords.medicationsMap.betaBlocker Boolean
medicalRecords.medicationsMap.betaBlockerNotes String
medicalRecords.medicationsMap.calciumChannelBlocker Boolean
medicalRecords.medicationsMap.calciumChannelBlockerNotes String
medicalRecords.medicationsMap.nitrates Boolean
medicalRecords.medicationsMap.nitratesNotes String
medicalRecords.medicationsMap.ACEInhibitor Boolean
medicalRecords.medicationsMap.ACEInhibitorNotes String
medicalRecords.medicationsMap.digoxin Boolean
medicalRecords.medicationsMap.digoxinNotes String
medicalRecords.medicationsMap.others Boolean
medicalRecords.medicationsMap.othersNotes String
medicalRecords.comments String
medicalRecords.attendingPhysician String

account uid of the doctor

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "treadmill-stress-test-patient-profile",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "treadmill-stress-test-patient-profile",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Treadmill Stress Test Patient Profile - Get

Back to top

Get an treadmill stress test patient profile medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

treadmill-stress-test-patient-profile
subtype String
order String

medical-procedure-order reference id
symptoms String
none String
angina String
priorMI Boolean
priorMILocation String
priorCorAngio Boolean
priorCorAngioWhenOrResults String
priorBypass Boolean
priorBypassWhenOrResults String
priorPTCA Boolean
priorPTCADuration String
hypertension Boolean
hypertensionDuration String
diabetesMellitus Boolean
diabetesMellitusDuration String
hyperlipidemia Boolean
hyperlipidemiaValue String
tobaccoHistory Boolean
tobaccoPackPerYear String
familyHistoryOfMI Boolean
familyHistoryOfMIFirstDegreeRelation String
valvularDxHistory Boolean
valvularDxHistoryValueLesion String
CHFHistory Boolean
medicationsMap Object
medicationsMap.betaBlocker Boolean
medicationsMap.betaBlockerNotes String
medicationsMap.calciumChannelBlocker Boolean
medicationsMap.calciumChannelBlockerNotes String
medicationsMap.nitrates Boolean
medicationsMap.nitratesNotes String
medicationsMap.ACEInhibitor Boolean
medicationsMap.ACEInhibitorNotes String
medicationsMap.digoxin Boolean
medicationsMap.digoxinNotes String
medicationsMap.others Boolean
medicationsMap.othersNotes String
comments String
attendingPhysician String

account uid of the doctor

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "treadmill-stress-test-patient-profile",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Treadmill Stress Test Patient Profile - Patch

Back to top

Update an treadmill stress test patient profile medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
order String optional

medical-procedure-order reference id
symptoms String optional
none String optional
angina String optional
priorMI Boolean optional
priorMILocation String optional
priorCorAngio Boolean optional
priorCorAngioWhenOrResults String optional
priorBypass Boolean optional
priorBypassWhenOrResults String optional
priorPTCA Boolean optional
priorPTCADuration String optional
hypertension Boolean optional
hypertensionDuration String optional
diabetesMellitus Boolean optional
diabetesMellitusDuration String optional
hyperlipidemia Boolean optional
hyperlipidemiaValue String optional
tobaccoHistory Boolean optional
tobaccoPackPerYear String optional
familyHistoryOfMI Boolean optional
familyHistoryOfMIFirstDegreeRelation String optional
valvularDxHistory Boolean optional
valvularDxHistoryValueLesion String optional
CHFHistory Boolean optional
medicationsMap Object optional
medicationsMap.betaBlocker Boolean
medicationsMap.betaBlockerNotes String
medicationsMap.calciumChannelBlocker Boolean
medicationsMap.calciumChannelBlockerNotes String
medicationsMap.nitrates Boolean
medicationsMap.nitratesNotes String
medicationsMap.ACEInhibitor Boolean
medicationsMap.ACEInhibitorNotes String
medicationsMap.digoxin Boolean
medicationsMap.digoxinNotes String
medicationsMap.others Boolean
medicationsMap.othersNotes String
comments String optional
attendingPhysician String optional

account uid of the doctor
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "symptoms": "some symptoms"
  }'

Parameters examples

json - Request-Example

{
  "symptoms": "some symptoms"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

treadmill-stress-test-patient-profile
subtype String
order String

medical-procedure-order reference id
symptoms String
none String
angina String
priorMI Boolean
priorMILocation String
priorCorAngio Boolean
priorCorAngioWhenOrResults String
priorBypass Boolean
priorBypassWhenOrResults String
priorPTCA Boolean
priorPTCADuration String
hypertension Boolean
hypertensionDuration String
diabetesMellitus Boolean
diabetesMellitusDuration String
hyperlipidemia Boolean
hyperlipidemiaValue String
tobaccoHistory Boolean
tobaccoPackPerYear String
familyHistoryOfMI Boolean
familyHistoryOfMIFirstDegreeRelation String
valvularDxHistory Boolean
valvularDxHistoryValueLesion String
CHFHistory Boolean
medicationsMap Object
medicationsMap.betaBlocker Boolean
medicationsMap.betaBlockerNotes String
medicationsMap.calciumChannelBlocker Boolean
medicationsMap.calciumChannelBlockerNotes String
medicationsMap.nitrates Boolean
medicationsMap.nitratesNotes String
medicationsMap.ACEInhibitor Boolean
medicationsMap.ACEInhibitorNotes String
medicationsMap.digoxin Boolean
medicationsMap.digoxinNotes String
medicationsMap.others Boolean
medicationsMap.othersNotes String
comments String
attendingPhysician String

account uid of the doctor

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "treadmill-stress-test-patient-profile",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Treadmill Stress Test Patient Profile - Post

Back to top

Create a medical record for treadmill stress test patient profile

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: treadmill-stress-test-patient-profile
subtype String optional
order String optional

medical-procedure-order reference id
symptoms String optional
none String optional
angina String optional
priorMI Boolean optional
priorMILocation String optional
priorCorAngio Boolean optional
priorCorAngioWhenOrResults String optional
priorBypass Boolean optional
priorBypassWhenOrResults String optional
priorPTCA Boolean optional
priorPTCADuration String optional
hypertension Boolean optional
hypertensionDuration String optional
diabetesMellitus Boolean optional
diabetesMellitusDuration String optional
hyperlipidemia Boolean optional
hyperlipidemiaValue String optional
tobaccoHistory Boolean optional
tobaccoPackPerYear String optional
familyHistoryOfMI Boolean optional
familyHistoryOfMIFirstDegreeRelation String optional
valvularDxHistory Boolean optional
valvularDxHistoryValueLesion String optional
CHFHistory Boolean optional
medicationsMap Object optional
medicationsMap.betaBlocker Boolean
medicationsMap.betaBlockerNotes String
medicationsMap.calciumChannelBlocker Boolean
medicationsMap.calciumChannelBlockerNotes String
medicationsMap.nitrates Boolean
medicationsMap.nitratesNotes String
medicationsMap.ACEInhibitor Boolean
medicationsMap.ACEInhibitorNotes String
medicationsMap.digoxin Boolean
medicationsMap.digoxinNotes String
medicationsMap.others Boolean
medicationsMap.othersNotes String
comments String optional
attendingPhysician String optional

account uid of the doctor
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "treadmill-stress-test-patient-profile",
    "symptoms": "some symptoms"
  }'

Parameters examples

json - Request-Example

{
  "type": "treadmill-stress-test-patient-profile",
  "symptoms": "some symptoms"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

treadmill-stress-test-patient-profile
subtype String
order String

medical-procedure-order reference id
symptoms String
none String
angina String
priorMI Boolean
priorMILocation String
priorCorAngio Boolean
priorCorAngioWhenOrResults String
priorBypass Boolean
priorBypassWhenOrResults String
priorPTCA Boolean
priorPTCADuration String
hypertension Boolean
hypertensionDuration String
diabetesMellitus Boolean
diabetesMellitusDuration String
hyperlipidemia Boolean
hyperlipidemiaValue String
tobaccoHistory Boolean
tobaccoPackPerYear String
familyHistoryOfMI Boolean
familyHistoryOfMIFirstDegreeRelation String
valvularDxHistory Boolean
valvularDxHistoryValueLesion String
CHFHistory Boolean
medicationsMap Object
medicationsMap.betaBlocker Boolean
medicationsMap.betaBlockerNotes String
medicationsMap.calciumChannelBlocker Boolean
medicationsMap.calciumChannelBlockerNotes String
medicationsMap.nitrates Boolean
medicationsMap.nitratesNotes String
medicationsMap.ACEInhibitor Boolean
medicationsMap.ACEInhibitorNotes String
medicationsMap.digoxin Boolean
medicationsMap.digoxinNotes String
medicationsMap.others Boolean
medicationsMap.othersNotes String
comments String
attendingPhysician String

account uid of the doctor

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "treadmill-stress-test-patient-profile",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Treadmill Stress Test Report - Delete

Back to top

Delete an treadmill stress test report medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

treadmill-stress-test-report
subtype String
order String

medical-procedure-order reference id
exerciseTest String
exerciseTestResults Object[]
exerciseTestResults.id String
exerciseTestResults.label String
exerciseTestResults.BPDiastolic Number

blood pressure component
exerciseTestResults.BPSystolic Number

blood pressure component
exerciseTestResults.heartRate Number
bloodPressureAndHeartRateRecovery Object[]
bloodPressureAndHeartRateRecovery.id String
bloodPressureAndHeartRateRecovery.label String
bloodPressureAndHeartRateRecovery.BPDiastolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.BPSystolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.heartRate Number
treadmillDurationScore Number

number of seconds
reasonForTermination String

reason why the test cannot continue
responseToExerciseTest String
restingECG String
exerciseECG String
exerciseBloodPressureStatus String

normal, abnormal
exerciseHeartRateStatus String

normal, abnormal
interpretation String
cardioRespiratoryFitness String

e.g. height, good, average, fair, low, very-low
remarks String
cardiologist String

doctor's account uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "treadmill-stress-test-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Treadmill Stress Test Report - Find

Back to top

Get treadmill stress test report medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=treadmill-stress-test-report" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

treadmill-stress-test-report
medicalRecords.subtype String
medicalRecords.order String

medical-procedure-order reference id
medicalRecords.exerciseTest String
medicalRecords.exerciseTestResults Object[]
medicalRecords.exerciseTestResults.id String
medicalRecords.exerciseTestResults.label String
medicalRecords.exerciseTestResults.BPDiastolic Number

blood pressure component
medicalRecords.exerciseTestResults.BPSystolic Number

blood pressure component
medicalRecords.exerciseTestResults.heartRate Number
medicalRecords.bloodPressureAndHeartRateRecovery Object[]
medicalRecords.bloodPressureAndHeartRateRecovery.id String
medicalRecords.bloodPressureAndHeartRateRecovery.label String
medicalRecords.bloodPressureAndHeartRateRecovery.BPDiastolic Number

blood pressure component
medicalRecords.bloodPressureAndHeartRateRecovery.BPSystolic Number

blood pressure component
medicalRecords.bloodPressureAndHeartRateRecovery.heartRate Number
medicalRecords.treadmillDurationScore Number

number of seconds
medicalRecords.reasonForTermination String

reason why the test cannot continue
medicalRecords.responseToExerciseTest String
medicalRecords.restingECG String
medicalRecords.exerciseECG String
medicalRecords.exerciseBloodPressureStatus String

normal, abnormal
medicalRecords.exerciseHeartRateStatus String

normal, abnormal
medicalRecords.interpretation String
medicalRecords.cardioRespiratoryFitness String

e.g. height, good, average, fair, low, very-low
medicalRecords.remarks String
medicalRecords.cardiologist String

doctor's account uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
   "type": "treadmill-stress-test-report",
   "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
   "type": "treadmill-stress-test-report",
   "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Treadmill Stress Test Report - Get

Back to top

Get an treadmill stress test report medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

treadmill-stress-test-report
subtype String
order String

medical-procedure-order reference id
exerciseTest String
exerciseTestResults Object[]
exerciseTestResults.id String
exerciseTestResults.label String
exerciseTestResults.BPDiastolic Number

blood pressure component
exerciseTestResults.BPSystolic Number

blood pressure component
exerciseTestResults.heartRate Number
bloodPressureAndHeartRateRecovery Object[]
bloodPressureAndHeartRateRecovery.id String
bloodPressureAndHeartRateRecovery.label String
bloodPressureAndHeartRateRecovery.BPDiastolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.BPSystolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.heartRate Number
treadmillDurationScore Number

number of seconds
reasonForTermination String

reason why the test cannot continue
responseToExerciseTest String
restingECG String
exerciseECG String
exerciseBloodPressureStatus String

normal, abnormal
exerciseHeartRateStatus String

normal, abnormal
interpretation String
cardioRespiratoryFitness String

e.g. height, good, average, fair, low, very-low
remarks String
cardiologist String

doctor's account uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "treadmill-stress-test-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Treadmill Stress Test Report - Patch

Back to top

Update an treadmill stress test report medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
order String optional

medical-procedure-order reference id
exerciseTest String optional
exerciseTestResults Object[] optional
exerciseTestResults.label String
exerciseTestResults.BPDiastolic Number

blood pressure component
exerciseTestResults.BPSystolic Number

blood pressure component
exerciseTestResults.heartRate Number
bloodPressureAndHeartRateRecovery Object[] optional
bloodPressureAndHeartRateRecovery.label String
bloodPressureAndHeartRateRecovery.BPDiastolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.BPSystolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.heartRate Number
treadmillDurationScore Number optional

number of seconds
reasonForTermination String optional

reason why the test cannot continue
responseToExerciseTest String optional
restingECG String optional
exerciseECG String optional
exerciseBloodPressureStatus String optional Allowed values: normal,abnormal
exerciseHeartRateStatus String optional Allowed values: normal,abnormal
interpretation String optional
cardioRespiratoryFitness String optional

e.g. height, good, average, fair, low, very-low
remarks String optional
cardiologist String optional

doctor's account uid
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "restingECG": "some restingECG"
  }'

Parameters examples

json - Request-Example

{
  "restingECG": "some restingECG"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

treadmill-stress-test-report
subtype String
order String

medical-procedure-order reference id
exerciseTest String
exerciseTestResults Object[]
exerciseTestResults.id String
exerciseTestResults.label String
exerciseTestResults.BPDiastolic Number

blood pressure component
exerciseTestResults.BPSystolic Number

blood pressure component
exerciseTestResults.heartRate Number
bloodPressureAndHeartRateRecovery Object[]
bloodPressureAndHeartRateRecovery.id String
bloodPressureAndHeartRateRecovery.label String
bloodPressureAndHeartRateRecovery.BPDiastolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.BPSystolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.heartRate Number
treadmillDurationScore Number

number of seconds
reasonForTermination String

reason why the test cannot continue
responseToExerciseTest String
restingECG String
exerciseECG String
exerciseBloodPressureStatus String

normal, abnormal
exerciseHeartRateStatus String

normal, abnormal
interpretation String
cardioRespiratoryFitness String

e.g. height, good, average, fair, low, very-low
remarks String
cardiologist String

doctor's account uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "treadmill-stress-test-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Treadmill Stress Test Report - Post

Back to top

Create a medical record for treadmill stress test report

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: treadmill-stress-test-report
subtype String optional
order String optional

medical-procedure-order reference id
exerciseTest String optional
exerciseTestResults Object[] optional
exerciseTestResults.label String
exerciseTestResults.BPDiastolic Number

blood pressure component
exerciseTestResults.BPSystolic Number

blood pressure component
exerciseTestResults.heartRate Number
bloodPressureAndHeartRateRecovery Object[] optional
bloodPressureAndHeartRateRecovery.label String
bloodPressureAndHeartRateRecovery.BPDiastolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.BPSystolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.heartRate Number
treadmillDurationScore Number optional

number of seconds
reasonForTermination String optional

reason why the test cannot continue
responseToExerciseTest String optional
restingECG String optional
exerciseECG String optional
exerciseBloodPressureStatus String optional Allowed values: normal,abnormal
exerciseHeartRateStatus String optional Allowed values: normal,abnormal
interpretation String optional
cardioRespiratoryFitness String optional

e.g. height, good, average, fair, low, very-low
remarks String optional
cardiologist String optional

doctor's account uid
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "treadmill-stress-test-report",
    "restingECG": "some restingECG"
  }'

Parameters examples

json - Request-Example

{
  "type": "treadmill-stress-test-report",
  "restingECG": "some restingECG"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

treadmill-stress-test-report
subtype String
order String

medical-procedure-order reference id
exerciseTest String
exerciseTestResults Object[]
exerciseTestResults.id String
exerciseTestResults.label String
exerciseTestResults.BPDiastolic Number

blood pressure component
exerciseTestResults.BPSystolic Number

blood pressure component
exerciseTestResults.heartRate Number
bloodPressureAndHeartRateRecovery Object[]
bloodPressureAndHeartRateRecovery.id String
bloodPressureAndHeartRateRecovery.label String
bloodPressureAndHeartRateRecovery.BPDiastolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.BPSystolic Number

blood pressure component
bloodPressureAndHeartRateRecovery.heartRate Number
treadmillDurationScore Number

number of seconds
reasonForTermination String

reason why the test cannot continue
responseToExerciseTest String
restingECG String
exerciseECG String
exerciseBloodPressureStatus String

normal, abnormal
exerciseHeartRateStatus String

normal, abnormal
interpretation String
cardioRespiratoryFitness String

e.g. height, good, average, fair, low, very-low
remarks String
cardiologist String

doctor's account uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "treadmill-stress-test-report",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Vaccination - Delete

Back to top

Delete an Vaccination medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

vaccination
subtype String
category String

for nesting
group String

for deeper nesting. e.g., for pedia: BCG, etc..
label String

e.g., general, birth, 4-8-weeks, etc...
vaccine String

vaccine name
expiresAt Number
administeredAt Number
administeredBy String

name or id
injectionSite String
lotNo String
note String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "vaccination",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Vaccination - Find

Back to top

Get Vaccination medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=vaccination" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

vaccination
medicalRecords.subtype String
medicalRecords.category String

for nesting
medicalRecords.group String

for deeper nesting. e.g., for pedia: BCG, etc..
medicalRecords.label String

e.g., general, birth, 4-8-weeks, etc...
medicalRecords.vaccine String

vaccine name
medicalRecords.expiresAt Number
medicalRecords.administeredAt Number
medicalRecords.administeredBy String

name or id
medicalRecords.injectionSite String
medicalRecords.lotNo String
medicalRecords.note String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "vaccination",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "vaccination",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Vaccination - Get

Back to top

Get an Vaccination medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

vaccination
subtype String
category String

for nesting
group String

for deeper nesting. e.g., for pedia: BCG, etc..
label String

e.g., general, birth, 4-8-weeks, etc...
vaccine String

vaccine name
expiresAt Number
administeredAt Number
administeredBy String

name or id
injectionSite String
lotNo String
note String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "vaccination",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Vaccination - Patch

Back to top

Update an Vaccination medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
category String optional

for nesting
group String optional

for deeper nesting. e.g., for pedia: BCG, etc..
label String optional

e.g., general, birth, 4-8-weeks, etc...
vaccine String optional

vaccine name
expiresAt Number optional
administeredAt Number optional
administeredBy String optional

name or id
injectionSite String optional
lotNo String optional
note String optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "category": "some category"
  }'

Parameters examples

json - Request-Example

{
  "category": "some category"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

vaccination
subtype String
category String

for nesting
group String

for deeper nesting. e.g., for pedia: BCG, etc..
label String

e.g., general, birth, 4-8-weeks, etc...
vaccine String

vaccine name
expiresAt Number
administeredAt Number
administeredBy String

name or id
injectionSite String
lotNo String
note String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "vaccination",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Vaccination - Post

Back to top

Create a medical record for Vaccination

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: vaccination
subtype String optional
category String optional

for nesting
group String optional

for deeper nesting. e.g., for pedia: BCG, etc..
label String optional

e.g., general, birth, 4-8-weeks, etc...
vaccine String optional

vaccine name
expiresAt Number optional
administeredAt Number optional
administeredBy String optional

name or id
injectionSite String optional
lotNo String optional
note String optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "vaccination",
    "category": "some category"
  }'

Parameters examples

json - Request-Example

{
  "type": "vaccination",
  "category": "some category"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

vaccination
subtype String
category String

for nesting
group String

for deeper nesting. e.g., for pedia: BCG, etc..
label String

e.g., general, birth, 4-8-weeks, etc...
vaccine String

vaccine name
expiresAt Number
administeredAt Number
administeredBy String

name or id
injectionSite String
lotNo String
note String

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "vaccination",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Vitals - Delete

Back to top

Delete an vitals medical record's details. Can only delete finalized items.

DELETE /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

vitals
subtype String
takenAt Number
height Number

cm
weight Number

kg
pulse Number

per min
respiration Number

per min
oxygenSaturation Number

percentage
temperature Number

celsius
temperatureMethod String

temperature checking method. e.g., mouth, etc...
bpDiastolic Number
bpSystolic Number
lmp Number
chestCircumference Number

cm
headCircumference Number

cm
waistCircumference Number

cm
neckCircumference Number

cm
abdominalCircumference Number

cm
o2sats Number
visualAcuityLeft String
visualAcuityRight String
visualAcuityDsntUncorrectL Number
visualAcuityDsntUncorrectR Number
visualAcuityDsntCorrectL Number
visualAcuityDsntCorrectR Number
visualAcuityNearUncorrectL Number
visualAcuityNearUncorrectR Number
visualAcuityNearCorrectL Number
visualAcuityNearCorrectR Number
visualAcuityVisionNormal String
visualAcuityVisionAbnormal String
visualRemarks String
colorVision String
chestInspiration Number
chestExpiration Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "vitals",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Vitals - Find

Back to top

Get vitals medical records details

GET /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records?type=vitals" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalRecords Object[]

array of medical records
medicalRecords.id String
medicalRecords.createdAt Number
medicalRecords.createdBy String
medicalRecords.account String

account-uid
medicalRecords.facility String

facility-id
medicalRecords.patient String

patient-uid
medicalRecords.encounter String
medicalRecords.attachmentURLs String[]
medicalRecords.originalCreationAt Number
medicalRecords.finalizedAt Number
medicalRecords.finalizedBy String
medicalRecords.provider String
medicalRecords.providerFee Number
medicalRecords.providerFeeType String

amount, percentage
medicalRecords.permissions Object[]
medicalRecords.permissions.uid String

account selector
medicalRecords.permissions.organization String

organization selector when privileges/roles are used
medicalRecords.permissions.privileges String[]
medicalRecords.permissions.roles String[]
medicalRecords.permissions.write Boolean

write to records
medicalRecords.permissions.share Boolean

share records
medicalRecords.type String

vitals
medicalRecords.subtype String
medicalRecords.takenAt Number
medicalRecords.height Number

cm
medicalRecords.weight Number

kg
medicalRecords.pulse Number

per min
medicalRecords.respiration Number

per min
medicalRecords.oxygenSaturation Number

percentage
medicalRecords.temperature Number

celsius
medicalRecords.temperatureMethod String

temperature checking method. e.g., mouth, etc...
medicalRecords.bpDiastolic Number
medicalRecords.bpSystolic Number
medicalRecords.lmp Number
medicalRecords.chestCircumference Number

cm
medicalRecords.headCircumference Number

cm
medicalRecords.waistCircumference Number

cm
medicalRecords.neckCircumference Number

cm
medicalRecords.abdominalCircumference Number

cm
medicalRecords.o2sats Number
medicalRecords.visualAcuityLeft String
medicalRecords.visualAcuityRight String
medicalRecords.visualAcuityDsntUncorrectL Number
medicalRecords.visualAcuityDsntUncorrectR Number
medicalRecords.visualAcuityDsntCorrectL Number
medicalRecords.visualAcuityDsntCorrectR Number
medicalRecords.visualAcuityNearUncorrectL Number
medicalRecords.visualAcuityNearUncorrectR Number
medicalRecords.visualAcuityNearCorrectL Number
medicalRecords.visualAcuityNearCorrectR Number
medicalRecords.visualAcuityVisionNormal String
medicalRecords.visualAcuityVisionAbnormal String
medicalRecords.visualRemarks String
medicalRecords.colorVision String
medicalRecords.chestInspiration Number
medicalRecords.chestExpiration Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "medical-record-id",
    "type": "vitals",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  },
  {
    "id": "medical-record-id",
    "type": "vitals",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "startedAt": "1564661697125"
  }
]

Vitals - Get

Back to top

Get an vitals medical record's details

GET /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

vitals
subtype String
takenAt Number
height Number

cm
weight Number

kg
pulse Number

per min
respiration Number

per min
oxygenSaturation Number

percentage
temperature Number

celsius
temperatureMethod String

temperature checking method. e.g., mouth, etc...
bpDiastolic Number
bpSystolic Number
lmp Number
chestCircumference Number

cm
headCircumference Number

cm
waistCircumference Number

cm
neckCircumference Number

cm
abdominalCircumference Number

cm
o2sats Number
visualAcuityLeft String
visualAcuityRight String
visualAcuityDsntUncorrectL Number
visualAcuityDsntUncorrectR Number
visualAcuityDsntCorrectL Number
visualAcuityDsntCorrectR Number
visualAcuityNearUncorrectL Number
visualAcuityNearUncorrectR Number
visualAcuityNearCorrectL Number
visualAcuityNearCorrectR Number
visualAcuityVisionNormal String
visualAcuityVisionAbnormal String
visualRemarks String
colorVision String
chestInspiration Number
chestExpiration Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "vitals",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Vitals - Patch

Back to top

Update an vitals medical record

PATCH /medical-records/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
takenAt Number optional
height Number optional

cm
weight Number optional

kg
pulse Number optional

per min
respiration Number optional

per min
oxygenSaturation Number optional

percentage
temperature Number optional

celsius
temperatureMethod String optional

temperature checking method. e.g., mouth, etc...
bpDiastolic Number optional
bpSystolic Number optional
lmp Number optional
chestCircumference Number optional

cm
headCircumference Number optional

cm
waistCircumference Number optional

cm
neckCircumference Number optional

cm
abdominalCircumference Number optional

cm
o2sats Number optional
visualAcuityLeft String optional
visualAcuityRight String optional
visualAcuityDsntUncorrectL Number optional
visualAcuityDsntUncorrectR Number optional
visualAcuityDsntCorrectL Number optional
visualAcuityDsntCorrectR Number optional
visualAcuityNearUncorrectL Number optional
visualAcuityNearUncorrectR Number optional
visualAcuityNearCorrectL Number optional
visualAcuityNearCorrectR Number optional
visualAcuityVisionNormal String optional
visualAcuityVisionAbnormal String optional
visualRemarks String optional
colorVision String optional
chestInspiration Number optional
chestExpiration Number optional
name String optional
description String optional
startedAt Number optional
createdAt Number optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee String optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records/<medical-records-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "weight": 50
  }'

Parameters examples

json - Request-Example

{
  "weight": 50
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

vitals
subtype String
takenAt Number
height Number

cm
weight Number

kg
pulse Number

per min
respiration Number

per min
oxygenSaturation Number

percentage
temperature Number

celsius
temperatureMethod String

temperature checking method. e.g., mouth, etc...
bpDiastolic Number
bpSystolic Number
lmp Number
chestCircumference Number

cm
headCircumference Number

cm
waistCircumference Number

cm
neckCircumference Number

cm
abdominalCircumference Number

cm
o2sats Number
visualAcuityLeft String
visualAcuityRight String
visualAcuityDsntUncorrectL Number
visualAcuityDsntUncorrectR Number
visualAcuityDsntCorrectL Number
visualAcuityDsntCorrectR Number
visualAcuityNearUncorrectL Number
visualAcuityNearUncorrectR Number
visualAcuityNearCorrectL Number
visualAcuityNearCorrectR Number
visualAcuityVisionNormal String
visualAcuityVisionAbnormal String
visualRemarks String
colorVision String
chestInspiration Number
chestExpiration Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "vitals",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

Vitals - Post

Back to top

Create a medical record for vitals

POST /medical-records

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
type String Allowed values: vitals
subtype String optional
takenAt Number optional
height Number optional

cm
weight Number optional

kg
pulse Number optional

per min
respiration Number optional

per min
oxygenSaturation Number optional

percentage
temperature Number optional

celsius
temperatureMethod String optional

temperature checking method. e.g., mouth, etc...
bpDiastolic Number optional
bpSystolic Number optional
lmp Number optional
chestCircumference Number optional

cm
headCircumference Number optional

cm
waistCircumference Number optional

cm
neckCircumference Number optional

cm
abdominalCircumference Number optional

cm
o2sats Number optional
visualAcuityLeft String optional
visualAcuityRight String optional
visualAcuityDsntUncorrectL Number optional
visualAcuityDsntUncorrectR Number optional
visualAcuityDsntCorrectL Number optional
visualAcuityDsntCorrectR Number optional
visualAcuityNearUncorrectL Number optional
visualAcuityNearUncorrectR Number optional
visualAcuityNearCorrectL Number optional
visualAcuityNearCorrectR Number optional
visualAcuityVisionNormal String optional
visualAcuityVisionAbnormal String optional
visualRemarks String optional
colorVision String optional
chestInspiration Number optional
chestExpiration Number optional
createdAt Number optional
account String optional

account-uid
facility String optional

facility-id
patient String optional

patient-uid
encounter String optional
attachmentURLs String[] optional
originalCreationAt Number optional
finalizedAt Number optional
finalizedBy String optional
provider String optional
providerFee Number optional
providerFeeType String optional Allowed values: amount,percentage
permissions Object[] optional
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records

Examples

Example usage:

curl "https://yourdomain.com/medical-records" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "vitals",
    "weight": 50
  }'

Parameters examples

json - Request-Example

{
  "type": "vitals",
  "weight": 50
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number
createdBy String
account String

account-uid
facility String

facility-id
patient String

patient-uid
encounter String
attachmentURLs String[]
originalCreationAt Number
finalizedAt Number
finalizedBy String
provider String
providerFee Number
providerFeeType String

amount, percentage
permissions Object[]
permissions.uid String

account selector
permissions.organization String

organization selector when privileges/roles are used
permissions.privileges String[]
permissions.roles String[]
permissions.write Boolean

write to records
permissions.share Boolean

share records
type String

vitals
subtype String
takenAt Number
height Number

cm
weight Number

kg
pulse Number

per min
respiration Number

per min
oxygenSaturation Number

percentage
temperature Number

celsius
temperatureMethod String

temperature checking method. e.g., mouth, etc...
bpDiastolic Number
bpSystolic Number
lmp Number
chestCircumference Number

cm
headCircumference Number

cm
waistCircumference Number

cm
neckCircumference Number

cm
abdominalCircumference Number

cm
o2sats Number
visualAcuityLeft String
visualAcuityRight String
visualAcuityDsntUncorrectL Number
visualAcuityDsntUncorrectR Number
visualAcuityDsntCorrectL Number
visualAcuityDsntCorrectR Number
visualAcuityNearUncorrectL Number
visualAcuityNearUncorrectR Number
visualAcuityNearCorrectL Number
visualAcuityNearCorrectR Number
visualAcuityVisionNormal String
visualAcuityVisionAbnormal String
visualRemarks String
colorVision String
chestInspiration Number
chestExpiration Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "medical-record-id",
  "type": "vitals",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "startedAt": "1564661697125"
}

results matching ""

    No results matching ""