Schema for Faraday Exam Metadata

From ExamMetadata.schema.yaml (faraday/ExamMetadata.schema)

---
$id: https://skeleton.botmd.io/faraday/ExamMetadata.schema
$schema: http://json-schema.org/draft-07/schema#

title: Exam Metadata
description: Metadata for Parkway exam.

type: object
additionalProperties: false
required: []

properties:
  is_cardiac:
    title: Is Cardiac
    description: Indicate whether this is a cardiac exam. Cardiac exam uses different template to generate order form.
    type: boolean

  synonyms:
    title: Synonyms
    description: Synonyms that is related to this exam.
    type: string

  available_at:
    title: Available at
    description: Facility that provide this exam.
    type: array
    items:
      type: string

  specific_rooms:
    title: Specific Room
    description: Room that provide this exam.
    type: array
    items:
      type: integer

  disclaimer_messages:
    title: Disclaimer Messages
    description: For frontend to display facility disclaimer messages
    type: array
    items:
      type: string

  fasting_instruction:
    title: Fasting Instruction
    description: Fasting instruction of this exam.
    type: string

  additional_field_templates:
    title: Additional field templates
    description: Templates of additional fields for this exam.
    type: array
    items:
      type: object
      required: [key]
      properties:
        key:
          title: Key
          description: Key of the template
          type: string

        name:
          title: name
          description: Template name
          type: string

        description:
          title: description
          description: Description of the template
          type: string

        categories:
          title: categories
          description: Categories of fields
          type: array
          items:
            type: object
            required: [key]
            properties:
              key:
                title: Key
                description: Key of the category
                type: string

              name:
                title: Name
                description: Name of the category
                type: string

              description:
                title: description
                description: Description of the category
                type: string

              fields:
                title: Fields
                description: Fields that is required for this exam
                type: array
                items:
                  type: object
                  required: [key]
                  properties:
                    key:
                      title: Key
                      description: Key of the field
                      type: string

                    name:
                      title: Name
                      description: Field name
                      type: string

                    type:
                      title: Type
                      description: Type of field
                      enum: [string, boolean]

                    value:
                      title: Value
                      description: Value of field
                      type: string

                    default:
                      title: Default
                      description: Default value of field
                      type: string

[Main Page] [Schema Documentation] [Examples]