HeyDonto FHIR R4 API Documentation (1.0)

API documentation for HeyDonto API users

Overview

URL https://heydonto.com

HeyDonto services@heydonto.com

Servers

Mock server

https://docs.heydonto.com/_mock/apis/fhir/openapi/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Account

Operations

ActivityDefinition

Operations

AdverseEvent

Operations

AllergyIntolerance

Operations

Appointment

Operations

Get FHIR R4 Appointments

Request

Query

_countnumber

Number of items to return

_page_tokenstring

Page token for fetching the next set of items

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/appointment?_count=0&_page_token=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

resourceTypeanyrequired

This is a Bundle resource

Value"Bundle"

Example: "Bundle"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

identifierobject(Identifier)

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

typeany

Indicates the purpose of this bundle - how it is intended to be used.

Enum"document""message""transaction""transaction-response""batch""batch-response""history""searchset""collection"

Example: "searchset"

_typeobject(Element)

Base definition for all elements in a resource.

timestampstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_timestampobject(Element)

Base definition for all elements in a resource.

totalnumber(unsignedInt)^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

_totalobject(Element)

Base definition for all elements in a resource.

linkArray of objects(Bundle_Link)

A series of links that provide context to this bundle.

Example: [{"relation":"search","url":"https://api.heydonto.com/fhir/appointment/?_count=20"},{"relation":"next","url":"https://api.heydonto.com/fhir/appointment/?_count=20&_page_token=TOKEN"},{"relation":"first","url":"https://api.heydonto.com/fhir/appointment/?_count=20"},{"relation":"self","url":"https://api.heydonto.com/fhir/appointment/?_count=20"}]

entryArray of objects(Appointment)

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Example: [{"resourceType":"Appointment","id":"example","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">Brian MRI results discussion</div>"},"status":"booked","serviceCategory":[{"coding":[{"system":"http://example.org/service-category","code":"gp","display":"General Practice"}]}],"serviceType":[{"coding":[{"code":"52","display":"General Discussion"}]}],"specialty":[{"coding":[{"system":"http://snomed.info/sct","code":"394814009","display":"General practice"}]}],"appointmentType":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0276","code":"FOLLOWUP","display":"A follow up visit from a previous appointment"}]},"reasonReference":[{"reference":"Condition/example","display":"Severe burn of left ear"}],"priority":5,"description":"Discussion on the results of your recent MRI","start":"2013-12-10T09:00:00Z","end":"2013-12-10T11:00:00Z","created":"2013-10-10","comment":"Further expand on the results of the MRI and determine the next actions that may be appropriate.","basedOn":[{"reference":"ServiceRequest/myringotomy"}],"participant":[{"actor":{"reference":"Patient/example","display":"Peter James Chalmers"},"required":"required","status":"accepted"},{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"ATND"}]}],"actor":{"reference":"Practitioner/example","display":"Dr Adam Careful"},"required":"required","status":"accepted"},{"actor":{"reference":"Location/1","display":"South Wing, second floor"},"required":"required","status":"accepted"}]}]

signatureobject(Signature)

A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

Response

application/json

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 100,
  "link": [
    { … },
    { … },
    { … },
    { … }
  ],
  "entry": [
    { … }
  ]
}

Create FHIR R4 Appointment

Request

Bodyapplication/jsonrequired

resourceTypeanyrequired

This is a Appointment resource

Value"Appointment"

Example: "Appointment"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

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.

extensionArray of objects(Extension)

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.

modifierExtensionArray of objects(Extension)

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).

identifierArray of objects(Identifier)

This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

statusany

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

Enum"proposed""pending""booked""arrived""fulfilled""cancelled""noshow""entered-in-error""checked-in""waitlist"

Example: "booked"

_statusobject(Element)

Base definition for all elements in a resource.

cancelationReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

serviceCategoryArray of objects(CodeableConcept)

A broad categorization of the service that is to be performed during this appointment.

Example: [{"coding":[{"system":"http://example.org/service-category","code":"gp","display":"General Practice"}]}]

serviceTypeArray of objects(CodeableConcept)

The specific service that is to be performed during this appointment.

Example: [{"coding":[{"code":"52","display":"General Discussion"}]}]

specialtyArray of objects(CodeableConcept)

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Example: [{"coding":[{"system":"http://snomed.info/sct","code":"394814009","display":"General practice"}]}]

appointmentTypeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reasonCodeArray of objects(CodeableConcept)

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

reasonReferenceArray of objects(Reference)

Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

Example: [{"reference":"Condition/example","display":"Severe burn of left ear"}]

prioritynumber(unsignedInt)^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

_priorityobject(Element)

Base definition for all elements in a resource.

descriptionstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_descriptionobject(Element)

Base definition for all elements in a resource.

supportingInformationArray of objects(Reference)

Additional information to support the appointment provided when making the appointment.

startstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_startobject(Element)

Base definition for all elements in a resource.

endstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_endobject(Element)

Base definition for all elements in a resource.

minutesDurationnumber(positiveInt)^[1-9][0-9]*$

An integer with a value that is positive (e.g. >0)

_minutesDurationobject(Element)

Base definition for all elements in a resource.

slotArray of objects(Reference)

The slots from the participants' schedules that will be filled by the appointment.

createdstring(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

_createdobject(Element)

Base definition for all elements in a resource.

commentstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_commentobject(Element)

Base definition for all elements in a resource.

patientInstructionstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_patientInstructionobject(Element)

Base definition for all elements in a resource.

basedOnArray of objects(Reference)

The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

Example: [{"reference":"ServiceRequest/myringotomy"}]

participantArray of objects(Appointment_Participant)required

List of participants involved in the appointment.

Example: [{"actor":{"reference":"Patient/example","display":"Peter James Chalmers"},"required":"required","status":"accepted"},{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"ATND"}]}],"actor":{"reference":"Practitioner/example","display":"Dr Adam Careful"},"required":"required","status":"accepted"},{"actor":{"reference":"Location/1","display":"South Wing, second floor"},"required":"required","status":"accepted"}]

participant[].idobject(#string)

An extension object type #string.

participant[].extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. 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.

participant[].modifierExtensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

participant[].typeArray of objects(#CodeableConcept)

Role of participant in the appointment.

participant[].actorobject(#Reference)

An extension object type #Reference.

participant[].requiredany

Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.

Enum"required""optional""information-only"

participant[]._requiredobject(#Element)

An extension object type #Element.

participant[].statusany

Participation status of the actor.

Enum"accepted""declined""tentative""needs-action"

participant[]._statusobject(#Element)

An extension object type #Element.

participant[].periodobject(#Period)

An extension object type #Period.

requestedPeriodArray of objects(Period)

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/appointment \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceType": "Appointment",
    "id": "example",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Brian MRI results discussion</div>"
    },
    "status": "booked",
    "serviceCategory": [
      {
        "coding": [
          {
            "system": "http://example.org/service-category",
            "code": "gp",
            "display": "General Practice"
          }
        ]
      }
    ],
    "serviceType": [
      {
        "coding": [
          {
            "code": "52",
            "display": "General Discussion"
          }
        ]
      }
    ],
    "specialty": [
      {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "394814009",
            "display": "General practice"
          }
        ]
      }
    ],
    "appointmentType": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
          "code": "FOLLOWUP",
          "display": "A follow up visit from a previous appointment"
        }
      ]
    },
    "reasonReference": [
      {
        "reference": "Condition/example",
        "display": "Severe burn of left ear"
      }
    ],
    "priority": 5,
    "description": "Discussion on the results of your recent MRI",
    "start": "2013-12-10T09:00:00Z",
    "end": "2013-12-10T11:00:00Z",
    "created": "2013-10-10",
    "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
    "basedOn": [
      {
        "reference": "ServiceRequest/myringotomy"
      }
    ],
    "participant": [
      {
        "actor": {
          "reference": "Patient/example",
          "display": "Peter James Chalmers"
        },
        "required": "required",
        "status": "accepted"
      },
      {
        "type": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                "code": "ATND"
              }
            ]
          }
        ],
        "actor": {
          "reference": "Practitioner/example",
          "display": "Dr Adam Careful"
        },
        "required": "required",
        "status": "accepted"
      },
      {
        "actor": {
          "reference": "Location/1",
          "display": "South Wing, second floor"
        },
        "required": "required",
        "status": "accepted"
      }
    ]
  }'

Responses

Bodyapplication/json

resourceTypeanyrequired

This is a Appointment resource

Value"Appointment"

Example: "Appointment"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

extensionArray of objects(Extension)

modifierExtensionArray of objects(Extension)

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

statusany

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

Enum"proposed""pending""booked""arrived""fulfilled""cancelled""noshow""entered-in-error""checked-in""waitlist"

Example: "booked"

_statusobject(Element)

Base definition for all elements in a resource.

cancelationReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

serviceCategoryArray of objects(CodeableConcept)

A broad categorization of the service that is to be performed during this appointment.

Example: [{"coding":[{"system":"http://example.org/service-category","code":"gp","display":"General Practice"}]}]

serviceTypeArray of objects(CodeableConcept)

The specific service that is to be performed during this appointment.

Example: [{"coding":[{"code":"52","display":"General Discussion"}]}]

specialtyArray of objects(CodeableConcept)

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Example: [{"coding":[{"system":"http://snomed.info/sct","code":"394814009","display":"General practice"}]}]

appointmentTypeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reasonCodeArray of objects(CodeableConcept)

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

reasonReferenceArray of objects(Reference)

Example: [{"reference":"Condition/example","display":"Severe burn of left ear"}]

prioritynumber(unsignedInt)^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

_priorityobject(Element)

Base definition for all elements in a resource.

descriptionstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_descriptionobject(Element)

Base definition for all elements in a resource.

supportingInformationArray of objects(Reference)

Additional information to support the appointment provided when making the appointment.

startstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_startobject(Element)

Base definition for all elements in a resource.

endstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_endobject(Element)

Base definition for all elements in a resource.

minutesDurationnumber(positiveInt)^[1-9][0-9]*$

An integer with a value that is positive (e.g. >0)

_minutesDurationobject(Element)

Base definition for all elements in a resource.

slotArray of objects(Reference)

The slots from the participants' schedules that will be filled by the appointment.

createdstring(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

_createdobject(Element)

Base definition for all elements in a resource.

commentstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_commentobject(Element)

Base definition for all elements in a resource.

patientInstructionstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_patientInstructionobject(Element)

Base definition for all elements in a resource.

basedOnArray of objects(Reference)

The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

Example: [{"reference":"ServiceRequest/myringotomy"}]

participantArray of objects(Appointment_Participant)required

List of participants involved in the appointment.

participant[].idobject(#string)

An extension object type #string.

participant[].extensionArray of objects(#Extension)

participant[].modifierExtensionArray of objects(#Extension)

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

participant[].typeArray of objects(#CodeableConcept)

Role of participant in the appointment.

participant[].actorobject(#Reference)

An extension object type #Reference.

participant[].requiredany

Enum"required""optional""information-only"

participant[]._requiredobject(#Element)

An extension object type #Element.

participant[].statusany

Participation status of the actor.

Enum"accepted""declined""tentative""needs-action"

participant[]._statusobject(#Element)

An extension object type #Element.

participant[].periodobject(#Period)

An extension object type #Period.

requestedPeriodArray of objects(Period)

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

Response

application/json

{
  "resourceType": "Appointment",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Brian MRI results discussion</div>"
  },
  "status": "booked",
  "serviceCategory": [
    { … }
  ],
  "serviceType": [
    { … }
  ],
  "specialty": [
    { … }
  ],
  "appointmentType": {
    "coding": [ … ]
  },
  "reasonReference": [
    { … }
  ],
  "priority": 5,
  "description": "Discussion on the results of your recent MRI",
  "start": "2013-12-10T09:00:00Z",
  "end": "2013-12-10T11:00:00Z",
  "created": "2013-10-10",
  "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
  "basedOn": [
    { … }
  ],
  "participant": [
    { … },
    { … },
    { … }
  ]
}

Get FHIR R4 Appointment by ID

Request

Path

idstringrequired

ID of the Appointment

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/appointment/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

resourceTypeanyrequired

This is a Appointment resource

Value"Appointment"

Example: "Appointment"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

extensionArray of objects(Extension)

modifierExtensionArray of objects(Extension)

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

statusany

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

Enum"proposed""pending""booked""arrived""fulfilled""cancelled""noshow""entered-in-error""checked-in""waitlist"

Example: "booked"

_statusobject(Element)

Base definition for all elements in a resource.

cancelationReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

serviceCategoryArray of objects(CodeableConcept)

A broad categorization of the service that is to be performed during this appointment.

Example: [{"coding":[{"system":"http://example.org/service-category","code":"gp","display":"General Practice"}]}]

serviceTypeArray of objects(CodeableConcept)

The specific service that is to be performed during this appointment.

Example: [{"coding":[{"code":"52","display":"General Discussion"}]}]

specialtyArray of objects(CodeableConcept)

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Example: [{"coding":[{"system":"http://snomed.info/sct","code":"394814009","display":"General practice"}]}]

appointmentTypeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reasonCodeArray of objects(CodeableConcept)

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

reasonReferenceArray of objects(Reference)

Example: [{"reference":"Condition/example","display":"Severe burn of left ear"}]

prioritynumber(unsignedInt)^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

_priorityobject(Element)

Base definition for all elements in a resource.

descriptionstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_descriptionobject(Element)

Base definition for all elements in a resource.

supportingInformationArray of objects(Reference)

Additional information to support the appointment provided when making the appointment.

startstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_startobject(Element)

Base definition for all elements in a resource.

endstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_endobject(Element)

Base definition for all elements in a resource.

minutesDurationnumber(positiveInt)^[1-9][0-9]*$

An integer with a value that is positive (e.g. >0)

_minutesDurationobject(Element)

Base definition for all elements in a resource.

slotArray of objects(Reference)

The slots from the participants' schedules that will be filled by the appointment.

createdstring(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

_createdobject(Element)

Base definition for all elements in a resource.

commentstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_commentobject(Element)

Base definition for all elements in a resource.

patientInstructionstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_patientInstructionobject(Element)

Base definition for all elements in a resource.

basedOnArray of objects(Reference)

The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

Example: [{"reference":"ServiceRequest/myringotomy"}]

participantArray of objects(Appointment_Participant)required

List of participants involved in the appointment.

participant[].idobject(#string)

An extension object type #string.

participant[].extensionArray of objects(#Extension)

participant[].modifierExtensionArray of objects(#Extension)

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

participant[].typeArray of objects(#CodeableConcept)

Role of participant in the appointment.

participant[].actorobject(#Reference)

An extension object type #Reference.

participant[].requiredany

Enum"required""optional""information-only"

participant[]._requiredobject(#Element)

An extension object type #Element.

participant[].statusany

Participation status of the actor.

Enum"accepted""declined""tentative""needs-action"

participant[]._statusobject(#Element)

An extension object type #Element.

participant[].periodobject(#Period)

An extension object type #Period.

requestedPeriodArray of objects(Period)

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

Response

application/json

{
  "resourceType": "Appointment",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Brian MRI results discussion</div>"
  },
  "status": "booked",
  "serviceCategory": [
    { … }
  ],
  "serviceType": [
    { … }
  ],
  "specialty": [
    { … }
  ],
  "appointmentType": {
    "coding": [ … ]
  },
  "reasonReference": [
    { … }
  ],
  "priority": 5,
  "description": "Discussion on the results of your recent MRI",
  "start": "2013-12-10T09:00:00Z",
  "end": "2013-12-10T11:00:00Z",
  "created": "2013-10-10",
  "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
  "basedOn": [
    { … }
  ],
  "participant": [
    { … },
    { … },
    { … }
  ]
}

Update FHIR R4 Appointment

Request

Path

idstringrequired

ID of the Appointment to update

Bodyapplication/jsonrequired

resourceTypeanyrequired

This is a Appointment resource

Value"Appointment"

Example: "Appointment"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

extensionArray of objects(Extension)

modifierExtensionArray of objects(Extension)

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

statusany

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

Enum"proposed""pending""booked""arrived""fulfilled""cancelled""noshow""entered-in-error""checked-in""waitlist"

Example: "booked"

_statusobject(Element)

Base definition for all elements in a resource.

cancelationReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

serviceCategoryArray of objects(CodeableConcept)

A broad categorization of the service that is to be performed during this appointment.

Example: [{"coding":[{"system":"http://example.org/service-category","code":"gp","display":"General Practice"}]}]

serviceTypeArray of objects(CodeableConcept)

The specific service that is to be performed during this appointment.

Example: [{"coding":[{"code":"52","display":"General Discussion"}]}]

specialtyArray of objects(CodeableConcept)

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Example: [{"coding":[{"system":"http://snomed.info/sct","code":"394814009","display":"General practice"}]}]

appointmentTypeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reasonCodeArray of objects(CodeableConcept)

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

reasonReferenceArray of objects(Reference)

Example: [{"reference":"Condition/example","display":"Severe burn of left ear"}]

prioritynumber(unsignedInt)^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

_priorityobject(Element)

Base definition for all elements in a resource.

descriptionstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_descriptionobject(Element)

Base definition for all elements in a resource.

supportingInformationArray of objects(Reference)

Additional information to support the appointment provided when making the appointment.

startstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_startobject(Element)

Base definition for all elements in a resource.

endstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_endobject(Element)

Base definition for all elements in a resource.

minutesDurationnumber(positiveInt)^[1-9][0-9]*$

An integer with a value that is positive (e.g. >0)

_minutesDurationobject(Element)

Base definition for all elements in a resource.

slotArray of objects(Reference)

The slots from the participants' schedules that will be filled by the appointment.

createdstring(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

_createdobject(Element)

Base definition for all elements in a resource.

commentstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_commentobject(Element)

Base definition for all elements in a resource.

patientInstructionstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_patientInstructionobject(Element)

Base definition for all elements in a resource.

basedOnArray of objects(Reference)

The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

Example: [{"reference":"ServiceRequest/myringotomy"}]

participantArray of objects(Appointment_Participant)required

List of participants involved in the appointment.

participant[].idobject(#string)

An extension object type #string.

participant[].extensionArray of objects(#Extension)

participant[].modifierExtensionArray of objects(#Extension)

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

participant[].typeArray of objects(#CodeableConcept)

Role of participant in the appointment.

participant[].actorobject(#Reference)

An extension object type #Reference.

participant[].requiredany

Enum"required""optional""information-only"

participant[]._requiredobject(#Element)

An extension object type #Element.

participant[].statusany

Participation status of the actor.

Enum"accepted""declined""tentative""needs-action"

participant[]._statusobject(#Element)

An extension object type #Element.

participant[].periodobject(#Period)

An extension object type #Period.

requestedPeriodArray of objects(Period)

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/appointment/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceType": "Appointment",
    "id": "example",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Brian MRI results discussion</div>"
    },
    "status": "booked",
    "serviceCategory": [
      {
        "coding": [
          {
            "system": "http://example.org/service-category",
            "code": "gp",
            "display": "General Practice"
          }
        ]
      }
    ],
    "serviceType": [
      {
        "coding": [
          {
            "code": "52",
            "display": "General Discussion"
          }
        ]
      }
    ],
    "specialty": [
      {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "394814009",
            "display": "General practice"
          }
        ]
      }
    ],
    "appointmentType": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
          "code": "FOLLOWUP",
          "display": "A follow up visit from a previous appointment"
        }
      ]
    },
    "reasonReference": [
      {
        "reference": "Condition/example",
        "display": "Severe burn of left ear"
      }
    ],
    "priority": 5,
    "description": "Discussion on the results of your recent MRI",
    "start": "2013-12-10T09:00:00Z",
    "end": "2013-12-10T11:00:00Z",
    "created": "2013-10-10",
    "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
    "basedOn": [
      {
        "reference": "ServiceRequest/myringotomy"
      }
    ],
    "participant": [
      {
        "actor": {
          "reference": "Patient/example",
          "display": "Peter James Chalmers"
        },
        "required": "required",
        "status": "accepted"
      },
      {
        "type": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                "code": "ATND"
              }
            ]
          }
        ],
        "actor": {
          "reference": "Practitioner/example",
          "display": "Dr Adam Careful"
        },
        "required": "required",
        "status": "accepted"
      },
      {
        "actor": {
          "reference": "Location/1",
          "display": "South Wing, second floor"
        },
        "required": "required",
        "status": "accepted"
      }
    ]
  }'

Responses

Bodyapplication/json

resourceTypeanyrequired

This is a Appointment resource

Value"Appointment"

Example: "Appointment"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

extensionArray of objects(Extension)

modifierExtensionArray of objects(Extension)

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

statusany

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

Enum"proposed""pending""booked""arrived""fulfilled""cancelled""noshow""entered-in-error""checked-in""waitlist"

Example: "booked"

_statusobject(Element)

Base definition for all elements in a resource.

cancelationReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

serviceCategoryArray of objects(CodeableConcept)

A broad categorization of the service that is to be performed during this appointment.

Example: [{"coding":[{"system":"http://example.org/service-category","code":"gp","display":"General Practice"}]}]

serviceTypeArray of objects(CodeableConcept)

The specific service that is to be performed during this appointment.

Example: [{"coding":[{"code":"52","display":"General Discussion"}]}]

specialtyArray of objects(CodeableConcept)

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Example: [{"coding":[{"system":"http://snomed.info/sct","code":"394814009","display":"General practice"}]}]

appointmentTypeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reasonCodeArray of objects(CodeableConcept)

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

reasonReferenceArray of objects(Reference)

Example: [{"reference":"Condition/example","display":"Severe burn of left ear"}]

prioritynumber(unsignedInt)^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

_priorityobject(Element)

Base definition for all elements in a resource.

descriptionstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_descriptionobject(Element)

Base definition for all elements in a resource.

supportingInformationArray of objects(Reference)

Additional information to support the appointment provided when making the appointment.

startstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_startobject(Element)

Base definition for all elements in a resource.

endstring(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

_endobject(Element)

Base definition for all elements in a resource.

minutesDurationnumber(positiveInt)^[1-9][0-9]*$

An integer with a value that is positive (e.g. >0)

_minutesDurationobject(Element)

Base definition for all elements in a resource.

slotArray of objects(Reference)

The slots from the participants' schedules that will be filled by the appointment.

createdstring(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

_createdobject(Element)

Base definition for all elements in a resource.

commentstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_commentobject(Element)

Base definition for all elements in a resource.

patientInstructionstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

_patientInstructionobject(Element)

Base definition for all elements in a resource.

basedOnArray of objects(Reference)

The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

Example: [{"reference":"ServiceRequest/myringotomy"}]

participantArray of objects(Appointment_Participant)required

List of participants involved in the appointment.

participant[].idobject(#string)

An extension object type #string.

participant[].extensionArray of objects(#Extension)

participant[].modifierExtensionArray of objects(#Extension)

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

participant[].typeArray of objects(#CodeableConcept)

Role of participant in the appointment.

participant[].actorobject(#Reference)

An extension object type #Reference.

participant[].requiredany

Enum"required""optional""information-only"

participant[]._requiredobject(#Element)

An extension object type #Element.

participant[].statusany

Participation status of the actor.

Enum"accepted""declined""tentative""needs-action"

participant[]._statusobject(#Element)

An extension object type #Element.

participant[].periodobject(#Period)

An extension object type #Period.

requestedPeriodArray of objects(Period)

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

Response

application/json

{
  "resourceType": "Appointment",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Brian MRI results discussion</div>"
  },
  "status": "booked",
  "serviceCategory": [
    { … }
  ],
  "serviceType": [
    { … }
  ],
  "specialty": [
    { … }
  ],
  "appointmentType": {
    "coding": [ … ]
  },
  "reasonReference": [
    { … }
  ],
  "priority": 5,
  "description": "Discussion on the results of your recent MRI",
  "start": "2013-12-10T09:00:00Z",
  "end": "2013-12-10T11:00:00Z",
  "created": "2013-10-10",
  "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
  "basedOn": [
    { … }
  ],
  "participant": [
    { … },
    { … },
    { … }
  ]
}

Delete FHIR R4 Appointment

Request

Path

idstringrequired

ID of the Appointment to delete

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/appointment/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Appointment successfully deleted

Bodyapplication/json

statusTextstringrequired

Example: "OK"

statusnumberrequired

Example: 200

Response

application/json

{
  "statusText": "OK",
  "status": 200
}

Get FHIR R4 Appointment history by ID

Request

Path

idstringrequired

ID of the Appointment

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/fhir/appointment/{id}/history' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

resourceTypeanyrequired

This is a Bundle resource

Value"Bundle"

typeanyrequired

Indicates that this is a history bundle.

Value"history"

entryArray of objectsrequired

A list of entries representing historical versions of the resource.

entry[].fullUrlstringrequired

Example: "https://api.heydonto.com/appointment/6eca4369-7183-446e-bab7-addc609972d3"

entry[].requestobjectrequired

entry[].request.methodstring

Enum"PUT""POST"

entry[].request.urlstring

Example: "https://api.heydonto.com/appointment/6eca4369-7183-446e-bab7-addc609972d3"

entry[].resourceobjectrequired

Example: {"resourceType":"Appointment","id":"example","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">Brian MRI results discussion</div>"},"status":"booked","serviceCategory":[{"coding":[{"system":"http://example.org/service-category","code":"gp","display":"General Practice"}]}],"serviceType":[{"coding":[{"code":"52","display":"General Discussion"}]}],"specialty":[{"coding":[{"system":"http://snomed.info/sct","code":"394814009","display":"General practice"}]}],"appointmentType":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0276","code":"FOLLOWUP","display":"A follow up visit from a previous appointment"}]},"reasonReference":[{"reference":"Condition/example","display":"Severe burn of left ear"}],"priority":5,"description":"Discussion on the results of your recent MRI","start":"2013-12-10T09:00:00Z","end":"2013-12-10T11:00:00Z","created":"2013-10-10","comment":"Further expand on the results of the MRI and determine the next actions that may be appropriate.","basedOn":[{"reference":"ServiceRequest/myringotomy"}],"participant":[{"actor":{"reference":"Patient/example","display":"Peter James Chalmers"},"required":"required","status":"accepted"},{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"ATND"}]}],"actor":{"reference":"Practitioner/example","display":"Dr Adam Careful"},"required":"required","status":"accepted"},{"actor":{"reference":"Location/1","display":"South Wing, second floor"},"required":"required","status":"accepted"}]}

entry[].responseobjectrequired

entry[].response.lastModifiedstring(date-time)

Example: "2024-10-29T01:05:22.739517+00:00"

entry[].response.locationstring

Example: "https://api.heydonto.com/appointment/6eca4369-7183-446e-bab7-addc609972d3/_history/MTczMDE2MzkyMjczOTUxNzAwMA"

entry[].response.statusstring

Example: "200 OK"

totalintegerrequired

Example: 2

Response

application/json

{
  "resourceType": "Bundle",
  "type": "history",
  "entry": [
    { … }
  ],
  "total": 2
}

AppointmentResponse

Operations

AuditEvent

Operations

Basic

Operations

Binary

Operations

BiologicallyDerivedProduct

Operations

BodyStructure

Operations

Bundle

Operations

CapabilityStatement

Operations

CarePlan

Operations

CareTeam

Operations

CatalogEntry

Operations

ChargeItem

Operations

ChargeItemDefinition

Operations

Claim

Operations

ClaimResponse

Operations

ClinicalImpression

Operations

CodeSystem

Operations

Communication

Operations

CommunicationRequest

Operations

CompartmentDefinition

Operations

Composition

Operations

ConceptMap

Operations

Condition

Operations

Contract

Operations

Coverage

Operations

CoverageEligibilityRequest

Operations

CoverageEligibilityResponse

Operations

DetectedIssue

Operations

Device

Operations

DeviceDefinition

Operations

DeviceMetric

Operations

DeviceRequest

Operations

DeviceUseStatement

Operations

DiagnosticReport

Operations

DocumentManifest

Operations

DocumentReference

Operations

EffectEvidenceSynthesis

Operations

Encounter

Operations

Endpoint

Operations

EnrollmentRequest

Operations

EnrollmentResponse

Operations

EpisodeOfCare

Operations

EventDefinition

Operations

Evidence

Operations

EvidenceVariable

Operations

ExampleScenario

Operations

ExplanationOfBenefit

Operations

FamilyMemberHistory

Operations

Flag

Operations

Goal

Operations

GraphDefinition

Operations

Group

Operations

GuidanceResponse

Operations

HealthcareService

Operations

ImagingStudy

Operations

Immunization

Operations

ImmunizationEvaluation

Operations

ImmunizationRecommendation

Operations

ImplementationGuide

Operations

InsurancePlan

Operations

Invoice

Operations

Library

Operations

Linkage

Operations

List

Operations

Location

Operations

Measure

Operations

MeasureReport

Operations

Media

Operations

Medication

Operations

MedicationAdministration

Operations

MedicationDispense

Operations

MedicationKnowledge

Operations

MedicationRequest

Operations

MedicationStatement

Operations

MedicinalProduct

Operations

MedicinalProductAuthorization

Operations

MedicinalProductContraindication

Operations

MedicinalProductIndication

Operations

MedicinalProductIngredient

Operations

MedicinalProductInteraction

Operations

MedicinalProductManufactured

Operations

MedicinalProductPackaged

Operations

MedicinalProductPharmaceutical

Operations

MedicinalProductUndesirableEffect

Operations

MessageDefinition

Operations

MessageHeader

Operations

MolecularSequence

Operations

NamingSystem

Operations

NutritionOrder

Operations

Observation

Operations

ObservationDefinition

Operations

OperationDefinition

Operations

OperationOutcome

Operations

Organization

Operations

OrganizationAffiliation

Operations

Parameters

Operations

Patient

Operations

PaymentNotice

Operations

PaymentReconciliation

Operations

Person

Operations

PlanDefinition

Operations

Practitioner

Operations

PractitionerRole

Operations

Procedure

Operations

Provenance

Operations

Questionnaire

Operations

QuestionnaireResponse

Operations

RelatedPerson

Operations

RequestGroup

Operations

ResearchDefinition

Operations

ResearchElementDefinition

Operations

ResearchStudy

Operations

ResearchSubject

Operations

RiskAssessment

Operations

RiskEvidenceSynthesis

Operations

Schedule

Operations

SearchParameter

Operations

ServiceRequest

Operations

Slot

Operations

Specimen

Operations

SpecimenDefinition

Operations

StructureDefinition

Operations

StructureMap

Operations

Subscription

Operations

Substance

Operations

SubstanceNucleicAcid

Operations

SubstancePolymer

Operations

SubstanceProtein

Operations

SubstanceReferenceInformation

Operations

SubstanceSourceMaterial

Operations

SubstanceSpecification

Operations

SupplyDelivery

Operations

SupplyRequest

Operations

Task

Operations

TerminologyCapabilities

Operations

TestReport

Operations

TestScript

Operations

ValueSet

Operations

VerificationResult

Operations

VisionPrescription

Operations

HeyDonto FHIR R4 API Documentation (1.0)

Account

ActivityDefinition

AdverseEvent

AllergyIntolerance

Appointment

Get FHIR R4 Appointments

Request

Responses

Was this helpful?

Create FHIR R4 Appointment

RequestExpand all

Responses

Was this helpful?

Get FHIR R4 Appointment by ID

Request

Responses

Was this helpful?

Update FHIR R4 Appointment

RequestExpand all

Responses

Was this helpful?

Delete FHIR R4 Appointment

Request

Responses

Was this helpful?

Get FHIR R4 Appointment history by ID

Request

Responses

Was this helpful?

AppointmentResponse

AuditEvent

Basic

Binary

BiologicallyDerivedProduct

BodyStructure

Bundle

CapabilityStatement

CarePlan

CareTeam

CatalogEntry

ChargeItem

ChargeItemDefinition

Claim

ClaimResponse

ClinicalImpression

CodeSystem

Communication

CommunicationRequest

CompartmentDefinition

Composition

ConceptMap

Condition

Consent

Contract

Coverage

CoverageEligibilityRequest

CoverageEligibilityResponse

DetectedIssue

Device

DeviceDefinition

DeviceMetric

DeviceRequest

DeviceUseStatement

DiagnosticReport

DocumentManifest

DocumentReference

EffectEvidenceSynthesis

Encounter

Endpoint

EnrollmentRequest

EnrollmentResponse

EpisodeOfCare

EventDefinition

Evidence

EvidenceVariable

ExampleScenario

ExplanationOfBenefit

FamilyMemberHistory

Flag

Request

Request