Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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.

Entity: Consultation

HL7 API

FHIR API

Web

Custom REST API

Facade (STU3)

Aggregated (R4)

Summary of interactions

Read

/Questionnaire

Write

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

Web

Custom REST API

Facade (STU3)

Aggregated (R4)

Summary of interactions

Read

/ProcedureRequest

Write

$send-questionnaire-request

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

Web

Custom REST API

Facade (STU3)

Aggregated (R4)

Summary of interactions

Read

/QuestionnaireResponse

Write

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

  • No labels