Appendix · JSON-LD Context
Appendix Com Context
JSON-LD context defining the semantic vocabulary for Appendix Com from Appendix.
21 Classes
57 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
appendix:
https://appendix.com/schema#
Classes
GetApiV1AgentEncountersEncounteridEventsResponse
PostApiV1AgentEncountersEncounteridEventsRequest
PostApiV1AgentEncountersEncounteridEventsReadRequest
GetApiV1PatientsResponse
PostApiV1PrescribingEncountersRequest
GetApiV1PrescribingEncountersIdDetailsResponse
PostApiV1PrescribingEncountersIdMessagesRequest
PostApiV1PrescribingEncountersIdMessagesResponse
PostApiV1PrescribingPatientsRequest
GetApiV1PrescribingPatientsIdResponse
PostApiV1PrescribingSandboxEncountersB1A2AdvanceRequest
PostApiV1PrescribingSandboxEncountersB1A2AdvanceResponse
GetApiV1UsersMeResponse
GetApiV1UsersMeApiKeysResponse
PostApiV1UsersMeApiKeysRequest
PostApiV1UsersMeApiKeysResponse
GetApiV1UsersMeSubmissionsResponse
PostPrescribingEncountersIdMessagesRequest
PostPrescribingEncountersIdMessagesResponse
PostPrescribingQueryRequest
PostPrescribingQueryResponse
Properties
| Property | Type | Container |
|---|---|---|
| encounterId | string | |
| state | string | |
| events | list | |
| message | string | |
| eventIds | string | |
| patients | list | |
| externalId | string | |
| createdAt | string | |
| sandbox | boolean | |
| status | string | |
| dataVisibility | string | |
| dataSharingConsentAt | string | |
| patient | ||
| clinicalLetter | string | |
| submittedAt | string | |
| conversation | list | |
| prescriptions | list | |
| rxCount | integer | |
| images | list | |
| messageId | string | |
| author | string | |
| viaApp | boolean | |
| first_name | string | |
| last_name | string | |
| date_of_birth | date | |
| sex | string | |
| zip | string | |
| phone | string | |
| patient_ref | string | |
| string | ||
| consent_attested | boolean | |
| consent_reference | string | |
| patient_id | string | |
| external_consent | string | |
| created_at | string | |
| event | string | |
| rx_count | integer | |
| outcome | string | |
| applied | string | |
| webhook | ||
| availableEvents | list | |
| id | string | |
| role | string | |
| identityVerification | ||
| keyId | string | |
| prefix | string | |
| label | string | |
| expiresAt | string | |
| lastUsedAt | string | |
| key | string | |
| submission | ||
| query | string | |
| external_id | string | |
| encounter_id | string | |
| submission_id | string | |
| final_decision_ready | string | |
| next_steps | string |
JSON-LD Document
{
"@context": {
"@vocab": "https://appendix.com/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"appendix": "https://appendix.com/schema#",
"GetApiV1AgentEncountersEncounteridEventsResponse": "appendix:GetApiV1AgentEncountersEncounteridEventsResponse",
"encounterId": {
"@id": "appendix:encounterId",
"@type": "xsd:string"
},
"state": {
"@id": "appendix:state",
"@type": "xsd:string"
},
"events": {
"@id": "appendix:events",
"@container": "@list"
},
"PostApiV1AgentEncountersEncounteridEventsRequest": "appendix:PostApiV1AgentEncountersEncounteridEventsRequest",
"message": {
"@id": "appendix:message",
"@type": "xsd:string"
},
"PostApiV1AgentEncountersEncounteridEventsReadRequest": "appendix:PostApiV1AgentEncountersEncounteridEventsReadRequest",
"eventIds": {
"@id": "appendix:eventIds",
"@type": "xsd:string"
},
"GetApiV1PatientsResponse": "appendix:GetApiV1PatientsResponse",
"patients": {
"@id": "appendix:patients",
"@container": "@list"
},
"PostApiV1PrescribingEncountersRequest": "appendix:PostApiV1PrescribingEncountersRequest",
"GetApiV1PrescribingEncountersIdDetailsResponse": "appendix:GetApiV1PrescribingEncountersIdDetailsResponse",
"externalId": {
"@id": "appendix:externalId",
"@type": "xsd:string"
},
"createdAt": {
"@id": "appendix:createdAt",
"@type": "xsd:string"
},
"sandbox": {
"@id": "appendix:sandbox",
"@type": "xsd:boolean"
},
"status": {
"@id": "appendix:status",
"@type": "xsd:string"
},
"dataVisibility": {
"@id": "appendix:dataVisibility",
"@type": "xsd:string"
},
"dataSharingConsentAt": {
"@id": "appendix:dataSharingConsentAt",
"@type": "xsd:string"
},
"patient": {
"@id": "appendix:patient"
},
"clinicalLetter": {
"@id": "appendix:clinicalLetter",
"@type": "xsd:string"
},
"submittedAt": {
"@id": "appendix:submittedAt",
"@type": "xsd:string"
},
"conversation": {
"@id": "appendix:conversation",
"@container": "@list"
},
"prescriptions": {
"@id": "appendix:prescriptions",
"@container": "@list"
},
"rxCount": {
"@id": "appendix:rxCount",
"@type": "xsd:integer"
},
"PostApiV1PrescribingEncountersIdMessagesRequest": "appendix:PostApiV1PrescribingEncountersIdMessagesRequest",
"images": {
"@id": "appendix:images",
"@container": "@list"
},
"PostApiV1PrescribingEncountersIdMessagesResponse": "appendix:PostApiV1PrescribingEncountersIdMessagesResponse",
"messageId": {
"@id": "appendix:messageId",
"@type": "xsd:string"
},
"author": {
"@id": "appendix:author",
"@type": "xsd:string"
},
"viaApp": {
"@id": "appendix:viaApp",
"@type": "xsd:boolean"
},
"PostApiV1PrescribingPatientsRequest": "appendix:PostApiV1PrescribingPatientsRequest",
"first_name": {
"@id": "appendix:first_name",
"@type": "xsd:string"
},
"last_name": {
"@id": "appendix:last_name",
"@type": "xsd:string"
},
"date_of_birth": {
"@id": "appendix:date_of_birth",
"@type": "xsd:date"
},
"sex": {
"@id": "appendix:sex",
"@type": "xsd:string"
},
"zip": {
"@id": "appendix:zip",
"@type": "xsd:string"
},
"phone": {
"@id": "appendix:phone",
"@type": "xsd:string"
},
"patient_ref": {
"@id": "appendix:patient_ref",
"@type": "xsd:string"
},
"email": {
"@id": "appendix:email",
"@type": "xsd:string"
},
"consent_attested": {
"@id": "appendix:consent_attested",
"@type": "xsd:boolean"
},
"consent_reference": {
"@id": "appendix:consent_reference",
"@type": "xsd:string"
},
"GetApiV1PrescribingPatientsIdResponse": "appendix:GetApiV1PrescribingPatientsIdResponse",
"patient_id": {
"@id": "appendix:patient_id",
"@type": "xsd:string"
},
"external_consent": {
"@id": "appendix:external_consent",
"@type": "xsd:string"
},
"created_at": {
"@id": "appendix:created_at",
"@type": "xsd:string"
},
"PostApiV1PrescribingSandboxEncountersB1A2AdvanceRequest": "appendix:PostApiV1PrescribingSandboxEncountersB1A2AdvanceRequest",
"event": {
"@id": "appendix:event",
"@type": "xsd:string"
},
"rx_count": {
"@id": "appendix:rx_count",
"@type": "xsd:integer"
},
"outcome": {
"@id": "appendix:outcome",
"@type": "xsd:string"
},
"PostApiV1PrescribingSandboxEncountersB1A2AdvanceResponse": "appendix:PostApiV1PrescribingSandboxEncountersB1A2AdvanceResponse",
"applied": {
"@id": "appendix:applied",
"@type": "xsd:string"
},
"webhook": {
"@id": "appendix:webhook"
},
"availableEvents": {
"@id": "appendix:availableEvents",
"@container": "@list"
},
"GetApiV1UsersMeResponse": "appendix:GetApiV1UsersMeResponse",
"id": {
"@id": "appendix:id",
"@type": "xsd:string"
},
"role": {
"@id": "appendix:role",
"@type": "xsd:string"
},
"identityVerification": {
"@id": "appendix:identityVerification"
},
"GetApiV1UsersMeApiKeysResponse": "appendix:GetApiV1UsersMeApiKeysResponse",
"keyId": {
"@id": "appendix:keyId",
"@type": "xsd:string"
},
"prefix": {
"@id": "appendix:prefix",
"@type": "xsd:string"
},
"label": {
"@id": "appendix:label",
"@type": "xsd:string"
},
"expiresAt": {
"@id": "appendix:expiresAt",
"@type": "xsd:string"
},
"lastUsedAt": {
"@id": "appendix:lastUsedAt",
"@type": "xsd:string"
},
"PostApiV1UsersMeApiKeysRequest": "appendix:PostApiV1UsersMeApiKeysRequest",
"PostApiV1UsersMeApiKeysResponse": "appendix:PostApiV1UsersMeApiKeysResponse",
"key": {
"@id": "appendix:key",
"@type": "xsd:string"
},
"GetApiV1UsersMeSubmissionsResponse": "appendix:GetApiV1UsersMeSubmissionsResponse",
"submission": {
"@id": "appendix:submission"
},
"PostPrescribingEncountersIdMessagesRequest": "appendix:PostPrescribingEncountersIdMessagesRequest",
"PostPrescribingEncountersIdMessagesResponse": "appendix:PostPrescribingEncountersIdMessagesResponse",
"PostPrescribingQueryRequest": "appendix:PostPrescribingQueryRequest",
"query": {
"@id": "appendix:query",
"@type": "xsd:string"
},
"external_id": {
"@id": "appendix:external_id",
"@type": "xsd:string"
},
"PostPrescribingQueryResponse": "appendix:PostPrescribingQueryResponse",
"encounter_id": {
"@id": "appendix:encounter_id",
"@type": "xsd:string"
},
"submission_id": {
"@id": "appendix:submission_id",
"@type": "xsd:string"
},
"final_decision_ready": {
"@id": "appendix:final_decision_ready",
"@type": "xsd:string"
},
"next_steps": {
"@id": "appendix:next_steps",
"@type": "xsd:string"
}
},
"@type": "schema:Dataset",
"schema:name": "Appendix API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects Appendix's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-11-01) from openapi/_ae-authored/appendix-com-openapi-generated.yml.",
"dcterms:created": "2026-11-01",
"dcterms:source": [
"openapi/_ae-authored/appendix-com-openapi-generated.yml"
]
}