12.15.11 JSON Schema for AppointmentResponse

Patient Administration Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Device, Patient, Practitioner, RelatedPerson

This is a representation of the json schema for AppointmentResponse, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/AppointmentResponse",
  "$ref": "#/definitions/AppointmentResponse",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "AppointmentResponse": {
      "description": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.",
      "properties": {
        "resourceType": {
          "description": "This is a AppointmentResponse resource",
          "const": "AppointmentResponse"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "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.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "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.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "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.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "identifier": {
          "description": "This records identifiers associated with this appointment response 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.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "appointment": {
          "description": "Appointment that this response is replying to.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "proposedNewTime": {
          "description": "Indicates that the response is proposing a different time that was initially requested.  The new proposed time will be indicated in the start and end properties.",
          "$ref": "#/definitions/boolean"
        },
        "_proposedNewTime": {
          "description": "Extensions for proposedNewTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "start": {
          "description": "Date/Time that the appointment is to take place, or requested new start time.",
          "$ref": "#/definitions/instant"
        },
        "_start": {
          "description": "Extensions for start",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "end": {
          "description": "This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.",
          "$ref": "#/definitions/instant"
        },
        "_end": {
          "description": "Extensions for end",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "participantType": {
          "description": "Role of participant in the appointment.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "actor": {
          "description": "A Person, Location, HealthcareService, or Device that is participating in the appointment.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "participantStatus": {
          "description": "Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.",
          "$ref": "#/definitions/code"
        },
        "_participantStatus": {
          "description": "Extensions for participantStatus",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "comment": {
          "description": "Additional comments about the appointment.",
          "$ref": "#/definitions/string"
        },
        "_comment": {
          "description": "Extensions for comment",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "recurring": {
          "description": "Indicates that this AppointmentResponse applies to all occurrences in a recurring request.",
          "$ref": "#/definitions/boolean"
        },
        "_recurring": {
          "description": "Extensions for recurring",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "occurrenceDate": {
          "description": "The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in `Appointment.occurrenceDate`).",
          "$ref": "#/definitions/date"
        },
        "_occurrenceDate": {
          "description": "Extensions for occurrenceDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "recurrenceId": {
          "description": "The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.",
          "$ref": "#/definitions/positiveInt"
        },
        "_recurrenceId": {
          "description": "Extensions for recurrenceId",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "appointment",
        "resourceType"
      ]
    }
  }
}