Entity: Consultation

Class Diagram

Consultation

Display

Team Coordinators can manage Consultations from the "Consultations" tab. Patients can complete a Consultation from the Events & messages page.

Please see the manual for more information.

Solutions

PKB solutions related to this data type:

Mappings

 

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

 

 

Facade (STU3)

Aggregated (R4)

 

 

Summary of interactions

Create

 

 

 

 

 

Read

 

/Questionnaire

 

 

 

Update

 

 

 

 

 

Delete

 

 

 

 

 

Entity: Consultation

Public ID String

An ID for this Consultation.

 

Questionnaire.id

 

 

 

Name String

A textual name for this Consultation.

 

Questionnaire.title

 

 

 

Creation Timestamp Timestamp

When the Consultation was created.

 

Questionnaire.date

 

 

 

Privacy Label Enum

  • GENERAL_HEALTH

  • MENTAL_HEALTH

  • SEXUAL_HEALTH

  • SOCIAL_CARE

 

Questionnaire.meta.security

 

 

 

Entity: Consultation Item

ID String

An ID for this Consultation Item, unique only within this Consultation.

 

Questionnaire.item.linkId

 

 

 

Text String

The text to display.

 

Questionnaire.item.text

 

 

 

Type Enum

  • TITLE

  • TEXT

  • RADIO

  • CHECKBOX

 

Questionnaire.item.type

 

 

 

Entity: Consultation Item Option

Text String

The value of the option.

 

Questionnaire.item.option

 

 

 

 

 

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

 

 

Facade (STU3)

Aggregated (R4)

 

 

Summary of interactions

Create

 

$send-questionnaire-request

 

 

 

Read

 

/ProcedureRequest

 

 

 

Update

 

 

 

 

 

Delete

 

 

 

 

 

Entity: Consultation Request

Public ID String

An ID for this Consultation Request.

 

 

 

 

 

Request Timestamp Timestamp

When the Consultation Request was created.

 

 

 

 

 

External Identifier Identifier

An externally specified identifier to identify this request.

 

 

 

 

 

 

 

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

 

 

Facade (STU3)

Aggregated (R4)

 

 

Summary of interactions

Create

 

 

 

 

 

Read

 

/QuestionnaireResponse

 

 

 

Update

 

 

 

 

 

Delete

 

 

 

 

 

Entity: Consultation Response

Public ID String

An ID for this Consultation Response.

 

QuestionnaireResponse.id

 

 

 

Request Timestamp Timestamp

When the Consultation Response was requested.

 

 

 

 

 

Completion Timestamp Timestamp

When the Consultation Response was completed.

 

QuestionnaireResponse.authored

 

 

 

Entity: Consultation Response Item

Text String

The value of the response.

 

QuestionnaireResponse.item.answer