DefinitionAPIPaginatedResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/elation-health/main/json-schema/elation-health-definition-apipaginated-response-schema.json",
  "title": "DefinitionAPIPaginatedResponse",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elation-health-definitions-api-openapi.yml#/components/schemas/DefinitionAPIPaginatedResponse",
  "required": [
    "results"
  ],
  "type": "object",
  "properties": {
    "results": {
      "title": "Results",
      "type": "array",
      "items": {
        "$ref": "#/$defs/DefinitionAPI"
      },
      "description": "Page of results requested"
    },
    "cursor": {
      "title": "Cursor",
      "type": "string",
      "description": "Cursor to query for the next page"
    },
    "next_page_url": {
      "title": "Next Page Url",
      "type": "string",
      "description": "Full URL to query for the next page"
    }
  },
  "$defs": {
    "Action": {
      "title": "Action",
      "required": [
        "type",
        "description"
      ],
      "type": "object",
      "properties": {
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/ActionEnum"
            }
          ],
          "description": "The type of action being performed."
        },
        "description": {
          "title": "Description",
          "type": "string",
          "description": "Human-readable description of the suggested action MAY be presented to the end-user."
        },
        "resource": {
          "title": "Resource",
          "anyOf": [
            {
              "$ref": "#/$defs/ValueSet"
            },
            {
              "$ref": "#/$defs/Observation"
            },
            {
              "$ref": "#/$defs/Condition"
            },
            {
              "$ref": "#/$defs/ServiceRequest"
            },
            {
              "$ref": "#/$defs/Immunization"
            },
            {
              "$ref": "#/$defs/AllergyIntolerance"
            },
            {
              "$ref": "#/$defs/Communication"
            },
            {
              "$ref": "#/$defs/Endpoint"
            },
            {
              "$ref": "#/$defs/DocumentReference"
            }
          ],
          "description": "A FHIR resource. When the type attribute is create, the resource attribute SHALL contain a new FHIR resource to be created. For update, this holds the updated resource in its entirety and not just the changed fields. Use of this field to communicate a string of a FHIR id for delete suggestions is DEPRECATED and resourceId SHOULD be used instead."
        },
        "resourceId": {
          "title": "Resourceid",
          "type": "string",
          "description": "A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete."
        }
      }
    },
    "ActionEnum": {
      "title": "ActionEnum",
      "enum": [
        "create",
        "update",
        "delete"
      ],
      "type": "string",
      "description": "An enumeration."
    },
    "AllergyIntolerance": {
      "title": "AllergyIntolerance",
      "required": [
        "patient"
      ],
      "type": "object",
      "properties": {
        "resource_type": {
          "title": "Resource Type",
          "type": "string"
        },
        "fhir_comments": {
          "title": "Fhir Comments",
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "id": {
          "title": "Logical id of this artifact",
          "maxLength": 64,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9\\-.]+$",
          "type": "string",
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."
        },
        "_id": {
          "title": "Extension field for ``id``.",
          "type": "string"
        },
        "implicitRules": {
          "title": "A set of rules under which this content was created",
          "pattern": "\\S*",
          "type": "string",
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."
        },
        "_implicitRules": {
          "title": "Extension field for ``implicitRules``.",
          "type": "string"
        },
        "language": {
          "title": "Language of the resource content",
          "pattern": "^[^\\s]+(\\s[^\\s]+)*$",
          "type": "string",
          "description": "The base language in which the resource is written."
        },
        "_language": {
          "title": "Extension field for ``language``.",
          "type": "string"
        },
        "meta": {
          "title": "Metadata about the resource",
          "type": "string",
          "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource."
        },
        "contained": {
          "title": "Contained, inline Resources",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."
        },
        "extension": {
          "title": "Additional content defined by implementations",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."
        },
        "modifierExtension": {
          "title": "Extensions that cannot be ignored",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."
        },
        "text": {
          "title": "Text summary of the resource, for human interpretation",
          "type": "string",
          "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."
        },
        "asserter": {
          "title": "Source of the information about the allergy",
          "type": "string",
          "description": "The source of the information about the allergy that is recorded."
        },
        "category": {
          "title": "food | medication | environment | biologic",
          "type": "array",
          "items": {
            "pattern": "^[^\\s]+(\\s[^\\s]+)*$",
            "type": "string"
          },
          "description": "Category of the identified substance."
        },
        "_category": {
          "title": "Extension field for ``category``.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "clinicalStatus": {
          "title": "active | inactive | resolved",
          "type": "string",
          "description": "The clinical status of the allergy or intolerance."
        },
        "code": {
          "title": "Code that identifies the allergy or intolerance",
          "type": "string",
          "description": "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement).  This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., \"Latex\"), an allergy or intolerance condition (e.g., \"Latex allergy\"), or a negated/excluded code for a specific substance or class (e.g., \"No latex allergy\") or a general or categorical negated statement (e.g.,  \"No known allergy\", \"No known drug allergies\").  Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'.  If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance."
        },
        "criticality": {
          "title": "low | high | unable-to-assess",
          "pattern": "^[^\\s]+(\\s[^\\s]+)*$",
          "type": "string",
          "description": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance."
        },
        "_criticality": {
          "title": "Extension field for ``criticality``.",
          "type": "string"
        },
        "encounter": {
          "title": "Encounter when the allergy or intolerance was asserted",
          "type": "string",
          "description": "The encounter when the allergy or intolerance was asserted."
        },
        "identifier": {
          "title": "External ids for this item",
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server."
        },
        "lastOccurrence": {
          "title": "Date(/time) of last known occurrence of a reaction",
          "type": "string",
          "description": "Represents the date and/or time of the last known occurrence of a reaction event.",
          "format": "date-time"
        },
        "_lastOccurrence": {
          "title": "Extension field for ``lastOccurrence``.",
          "type": "string"
        },
        "note": {
          "title": "Additional text not captured in other fields",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields."
        },
        "onsetAge": {
          "title": "When allergy or intolerance was identified",
          "type": "integer",
          "description": "Estimated or actual date,  date-time, or age when allergy or intolerance was identified."
        },
        "onsetDateTime": {
          "title": "When allergy or intolerance was identified",
          "type": "string",
          "description": "Estimated or actual date,  date-time, or age when allergy or intolerance was identified.",
          "format": "date-time"
        },
        "_onsetDateTime": {
          "title": "Extension field for ``onsetDateTime``.",
          "type": "string"
        },
        "onsetPeriod": {
          "title": "When allergy or intolerance was identified",
          "type": "string",
          "description": "Estimated or actual date,  date-time, or age when allergy or intolerance was identified."
        },
        "onsetRange": {
          "title": "When allergy or intolerance was identified",
          "type": "integer",
          "description": "Estimated or actual date,  date-time, or age when allergy or intolerance was identified."
        },
        "onsetString": {
          "title": "When allergy or intolerance was identified",
          "pattern": "[ \\r\\n\\t\\S]+",
          "type": "string",
          "description": "Estimated or actual date,  date-time, or age when allergy or intolerance was identified."
        },
        "_onsetString": {
          "title": "Extension field for ``onsetString``.",
          "type": "string"
        },
        "patient": {
          "title": "Who the sensitivity is for",
          "type": "string",
          "description": "The patient who has the allergy or intolerance."
        },
        "reaction": {
          "title": "Adverse Reaction Events linked to exposure to substance",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Details about each adverse reaction event linked to exposure to the identified substance."
        },
        "recordedDate": {
          "title": "Date first version of the resource instance was recorded",
          "type": "string",
          "description": "The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.",
          "format": "date-time"
        },
        "_recordedDate": {
          "title": "Extension field for ``recordedDate``.",
          "type": "string"
        },
        "recorder": {
          "title": "Who recorded the sensitivity",
          "type": "string",
          "description": "Individual who recorded the record and takes responsibility for its content."
        },
        "type": {
          "title": "allergy | intolerance - Underlying mechanism (if known)",
          "pattern": "^[^\\s]+(\\s[^\\s]+)*$",
          "type": "string",
          "description": "Identification of the underlying physiological mechanism for the reaction risk."
        },
        "_type": {
          "title": "Extension field for ``type``.",
          "type": "string"
        },
        "verificationStatus": {
          "title": "unconfirmed | confirmed | refuted | entered-in-error",
          "type": "string",
          "description": "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product)."
        }
      },
      "additionalProperties": false,
      "description": "Disclaimer: Any field name ends with ``__ext`` does't part of\nResource StructureDefinition, instead used to enable Extensibility feature\nfor FHIR Primitive Data Types.\n\nAllergy or Intolerance (generally: Risk of adverse reaction to a substance).\nRisk of harmful or undesirable, physiological response which is unique to\nan individual and associated with exposure to a substance."
    },
    "Coding": {
      "title": "Coding",
      "type": "object",
      "properties": {
        "code": {
          "title": "Code",
          "type": "string",
          "description": "The code for what is being represented"
        },
        "display": {
          "title": "Display",
          "type": "string",
          "description": "A codesystem for this code."
        },
        "system": {
          "title": "System",
          "type": "string",
          "description": "A short, human-readable label to display."
        },
        "context": {
          "title": "Context",
          "allOf": [
            {
              "$ref": "#/$defs/CodingContext"
            }
          ],
          "description": "Context for the coding within the EHR. For use as part of the closing code structure"
        }
      }
    },
    "CodingContext": {
      "title": "CodingContext",
      "type": "object",
      "properties": {
        "target": {
          "allOf": [
            {
              "$ref": "#/$defs/TargetEnum"
            }
          ],
          "description": "Application target to constrain this closing code to"
        }
      }
    },
    "Communication": {
      "title": "Communication",
      "type": "object",
      "properties": {
        "resource_type": {
          "title": "Resource Type",
          "type": "string"
        },
        "fhir_comments": {
          "title": "Fhir Comments",
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "id": {
          "title": "Logical id of this artifact",
          "maxLength": 64,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9\\-.]+$",
          "type": "string",
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."
        },
        "_id": {
          "title": "Extension field for ``id``.",
          "type": "string"
        },
        "implicitRules": {
          "title": "A set of rules under which this content was created",
          "pattern": "\\S*",
          "type": "string",
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."
        },
        "_implicitRules": {
          "title": "Extension field for ``implicitRules``.",
          "type": "string"
        },
        "language": {
          "title": "Language of the resource content",
          "pattern": "^[^\\s]+(\\s[^\\s]+)*$",
          "type": "string",
          "description": "The base language in which the resource is written."
        },
        "_language": {
          "title": "Extension field for ``language``.",
          "type": "string"
        },
        "meta": {
          "title": "Metadata about the resource",
          "type": "string",
          "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource."
        },
        "contained": {
          "title": "Contained, inline Resources",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."
        },
        "extension": {
          "title": "Additional content defined by implementations",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."
        },
        "modifierExtension": {
          "title": "Extensions that cannot be ignored",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."
        },
        "text": {
          "title": "Text summary of the resource, for human interpretation",
          "type": "string",
          "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."
        },
        "about": {
          "title": "Resources that pertain to this communication",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Other resources that pertain to this communication and to which this communication should be associated."
        },
        "basedOn": {
          "title": "Request fulfilled by this communication",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "An order, proposal or plan fulfilled in whole or in part by this Communication."
        },
        "category": {
          "title": "Message category",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The type of message conveyed such as alert, notification, reminder, instruction, etc."
        },
        "encounter": {
          "title": "Encounter created as part of",
          "type": "string",
          "description": "The Encounter during which this Communication was created or to which the creation of this record is tightly associated."
        },
        "identifier": {
          "title": "Unique identifier",
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server."
        },
        "inResponseTo": {
          "title": "Reply to",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Prior communication that this communication is in response to."
        },
        "instantiatesCanonical": {
          "title": "Instantiates FHIR protocol or definition",
          "type": "array",
          "items": {
            "pattern": "\\S*",
            "type": "string"
          },
          "description": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication."
        },
        "_instantiatesCanonical": {
          "title": "Extension field for ``instantiatesCanonical``.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "instantiatesUri": {
          "title": "Instantiates external protocol or definition",
          "type": "array",
          "items": {
            "pattern": "\\S*",
            "type": "string"
          },
          "description": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication."
        },
        "_instantiatesUri": {
          "title": "Extension field for ``instantiatesUri``.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "medium": {
          "title": "A channel of communication",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A channel that was used for this communication (e.g. email, fax)."
        },
        "note": {
          "title": "Comments made about the communication",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Additional notes or commentary about the communication by the sender, receiver or other interested parties."
        },
        "partOf": {
          "title": "Part of this action",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "payload": {
          "title": "Message payload",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Text, attachment(s), or resource(s) that was communicated to the recipient."
        },
        "priority": {
          "title": "routine | urgent | asap | stat",
          "pattern": "^[^\\s]+(\\s[^\\s]+)*$",
          "type": "string",
          "description": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine."
        },
        "_priority": {
          "title": "Extension field for ``priority``.",
          "type": "string"
        },
        "reasonCode": {
          "title": "Indication for message",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The reason or justification for the communication."
        },
        "reasonReference": {
          "title": "Why was communication done?",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Indicates another resource whose existence justifies this communication."
        },
        "received": {
          "title": "When received",
          "type": "string",
          "description": "The time when this communication arrived at the destination.",
          "format": "date-time"
        },
        "_received": {
          "title": "Extension field for ``received``.",
          "type": "string"
        },
        "recipient": {
          "title": "Message recipient",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient.  Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time)."
        },
        "sender": {
          "title": "Message sender",
          "type": "string",
          "description": "The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication."
        },
        "sent": {
          "title": "When sent",
          "type": "string",
          "description": "The time when this communication was sent.",
          "format": "date-time"
        },
        "_sent": {
          "title": "Extension field for ``sent``.",
          "type": "string"
        },
        "status": {
          "title": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
          "pattern": "^[^\\s]+(\\s[^\\s]+)*$",
          "type": "string",
          "description": "The status of the transmission."
        },
        "_status": {
          "title": "Extension field for ``status``.",
          "type": "string"
        },
        "statusReason": {
          "title": "Reason for current status",
          "type": "string",
          "description": "Captures the reason for the current state of the Communication."
        },
        "subject": {
          "title": "Focus of message",
          "type": "string",
          "description": "The patient or group that was the focus of this communication."
        },
        "topic": {
          "title": "Description of the purpose/content",
          "type": "string",
          "description": "Description of the purpose/content, similar to a subject line in an email."
        }
      },
      "additionalProperties": false,
      "description": "Disclaimer: Any field name ends with ``__ext`` does't part of\nResource StructureDefinition, instead used to enable Extensibility feature\nfor FHIR Primitive Data Types.\n\nA record of information transmitted from a sender to a receiver.\nAn occurrence of information being transmitted; e.g. an alert that was sent\nto a responsible provider, a public health agency that was notified about a\nreportable condition."
    },
    "Condition": {
      "title": "Condition",
      "required": [
        "subject"
      ],
      "type": "object",
      "properties": {
        "resource_type": {
          "title": "Resource Type",
          "type": "string"
        },
        "fhir_comments": {
          "title": "Fhir Comments",
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "id": {
          "title": "Logical id of this artifact",
          "maxLength": 64,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9\\-.]+$",
          "type": "string",
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."
        },
        "_id": {
          "title": "Extension field for ``id``.",
          "type": "string"
        },
        "implicitRules": {
          "title": "A set of rules under which this content was created",
          "pattern": "\\S*",
          "type": "string",
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."
        },
        "_implicitRules": {
          "title": "Extension field for ``implicitRules``.",
          "type": "string"
        },
        "language": {
          "title": "Language of the resource content",
          "pattern": "^[^\\s]+(\\s[^\\s]+)*$",
          "type": "string",
          "description": "The base language in which the resource is written."
        },
        "_language": {
          "title": "Extension field for ``language``.",
          "type": "string"
        },
        "meta": {
          "title": "Metadata about the resource",
          "type": "string",
          "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource."
        },
        "contained": {
          "title": "Contained, inline Resources",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."
        },
        "extension": {
          "title": "Additional content defined by implementations",
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "May be used to represent additional information that is not

# --- truncated at 32 KB (135 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-definition-apipaginated-response-schema.json