This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Appointmentresponse.questionnaire.json

Raw JSON (canonical form)

Generated Questionnaire for AppointmentResponse

{
  "resourceType": "Questionnaire",
  "id": "qs1",
  "contained": [
    {
      "resourceType": "ValueSet",
      "id": "vs2",
      "url": "urn:uuid:7cd64f8b-f132-4c6e-9690-3f18dd695a6f",
      "name": "Type options for AppointmentResponse.actor",
      "description": "Type options for AppointmentResponse.actor",
      "status": "active",
      "expansion": {
        "identifier": "urn:uuid:646c933a-5797-4eae-a112-9944f4c2db77",
        "timestamp": "2015-03-27T00:17:46+11:00",
        "contains": [
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Patient",
            "display": "Patient"
          },
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Practitioner",
            "display": "Practitioner"
          },
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "RelatedPerson",
            "display": "RelatedPerson"
          },
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Device",
            "display": "Device"
          },
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "HealthcareService",
            "display": "HealthcareService"
          },
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Location",
            "display": "Location"
          }
        ]
      }
    }
  ],
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986"
    }
  ],
  "status": "draft",
  "date": "2015-03-27T00:13:00+11:00",
  "publisher": "HL7 FHIR Project (Patient Administration)",
  "group": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
        "valueString": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection."
      }
    ],
    "linkId": "AppointmentResponse",
    "title": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection",
    "required": true,
    "repeats": false,
    "group": [
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "AppointmentResponse.id",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "AppointmentResponse.id.value",
            "text": "Logical id of this artefact",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."
          }
        ],
        "linkId": "AppointmentResponse.meta",
        "text": "Metadata about the resource",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "uri"
          }
        ],
        "linkId": "AppointmentResponse.implicitRules",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "AppointmentResponse.implicitRules.value",
            "text": "A set of rules under which this content was created",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "AppointmentResponse.language",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "AppointmentResponse.language.value",
            "text": "language",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A human-readable narrative that contains a summary of the resource, and may 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
          }
        ],
        "linkId": "AppointmentResponse.text",
        "text": "Text summary of the resource, for human interpretation",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."
          }
        ],
        "linkId": "AppointmentResponse.contained",
        "text": "Contained, inline Resources",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "This records identifiers associated with this appointment response concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Identifier"
          }
        ],
        "linkId": "AppointmentResponse.identifier",
        "text": "External Ids for this item",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "AppointmentResponse.identifier.label",
            "text": "label:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "AppointmentResponse.identifier.system",
            "text": "system:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "AppointmentResponse.identifier.value",
            "text": "value:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Parent appointment that this response is replying to."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Reference"
          }
        ],
        "linkId": "AppointmentResponse.appointment",
        "required": true,
        "repeats": true,
        "question": [
          {
            "extension": [
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                "valueString": "/Appointment?subject=$subj&patient=$subj&encounter=$encounter"
              }
            ],
            "linkId": "AppointmentResponse.appointment.value",
            "text": "Parent appointment that this response is replying to",
            "type": "reference",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Role of participant in the appointment."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "CodeableConcept"
          }
        ],
        "linkId": "AppointmentResponse.participantType",
        "text": "Role of participant in the appointment",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "AppointmentResponse.participantType.coding",
            "text": "code:",
            "type": "choice",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "AppointmentResponse.participantType.text",
            "text": "text:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A Person, Location/HealthcareService or Device that is participating in the appointment."
          }
        ],
        "linkId": "AppointmentResponse.actor",
        "text": "A Person, Location/HealthcareService or Device that is participating in the appointment",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "AppointmentResponse.actor._type",
            "text": "type",
            "type": "choice",
            "required": false,
            "repeats": false,
            "options": {
              "reference": "#vs2"
            },
            "group": [
              {
                "extension": [
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Reference"
                  }
                ],
                "linkId": "AppointmentResponse.actor._Patient",
                "question": [
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                        "valueString": "/Patient?subject=$subj&patient=$subj&encounter=$encounter"
                      }
                    ],
                    "linkId": "AppointmentResponse.actor._Patient.value",
                    "text": "Patient",
                    "type": "reference",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Reference"
                  }
                ],
                "linkId": "AppointmentResponse.actor._Practitioner",
                "question": [
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                        "valueString": "/Practitioner?subject=$subj&patient=$subj&encounter=$encounter"
                      }
                    ],
                    "linkId": "AppointmentResponse.actor._Practitioner.value",
                    "text": "Practitioner",
                    "type": "reference",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Reference"
                  }
                ],
                "linkId": "AppointmentResponse.actor._RelatedPerson",
                "question": [
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                        "valueString": "/RelatedPerson?subject=$subj&patient=$subj&encounter=$encounter"
                      }
                    ],
                    "linkId": "AppointmentResponse.actor._RelatedPerson.value",
                    "text": "RelatedPerson",
                    "type": "reference",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Reference"
                  }
                ],
                "linkId": "AppointmentResponse.actor._Device",
                "question": [
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                        "valueString": "/Device?subject=$subj&patient=$subj&encounter=$encounter"
                      }
                    ],
                    "linkId": "AppointmentResponse.actor._Device.value",
                    "text": "Device",
                    "type": "reference",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Reference"
                  }
                ],
                "linkId": "AppointmentResponse.actor._HealthcareService",
                "question": [
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                        "valueString": "/HealthcareService?subject=$subj&patient=$subj&encounter=$encounter"
                      }
                    ],
                    "linkId": "AppointmentResponse.actor._HealthcareService.value",
                    "text": "HealthcareService",
                    "type": "reference",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Reference"
                  }
                ],
                "linkId": "AppointmentResponse.actor._Location",
                "question": [
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                        "valueString": "/Location?subject=$subj&patient=$subj&encounter=$encounter"
                      }
                    ],
                    "linkId": "AppointmentResponse.actor._Location.value",
                    "text": "Location",
                    "type": "reference",
                    "required": false,
                    "repeats": false
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "AppointmentResponse.participantStatus",
        "required": true,
        "repeats": true,
        "question": [
          {
            "linkId": "AppointmentResponse.participantStatus.value",
            "text": "participant status",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "This comment is particularly important when the responder is declining, tentative or requesting another time to indicate the reasons why."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "AppointmentResponse.comment",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "AppointmentResponse.comment.value",
            "text": "Additional comments about the appointment",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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 start time."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "instant"
          }
        ],
        "linkId": "AppointmentResponse.start",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "AppointmentResponse.start.value",
            "text": "Date/Time that the appointment is to take place, or requested new start time",
            "type": "instant",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "instant"
          }
        ],
        "linkId": "AppointmentResponse.end",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "AppointmentResponse.end.value",
            "text": "Date/Time that the appointment is to conclude, or requested new end time",
            "type": "instant",
            "required": false,
            "repeats": false
          }
        ]
      }
    ]
  }
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.