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
Generated Questionnaire for Appointment
{
"resourceType": "Questionnaire",
"id": "qs1",
"contained": [
{
"resourceType": "ValueSet",
"id": "vs2",
"url": "urn:uuid:2ae9e7b5-e380-46fa-8ac9-f2d784a996fe",
"name": "Type options for Appointment.participant.actor",
"description": "Type options for Appointment.participant.actor",
"status": "active",
"expansion": {
"identifier": "urn:uuid:f842cceb-b049-4d8e-84eb-e2aa08e0f6e7",
"timestamp": "2015-03-27T00:17:45+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 booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)."
}
],
"linkId": "Appointment",
"title": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)",
"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": "Appointment.id",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.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": "Appointment.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": "Appointment.implicitRules",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.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": "Appointment.language",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.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": "Appointment.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": "Appointment.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 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 (e.g. in CDA documents, or in written / printed documentation)."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Identifier"
}
],
"linkId": "Appointment.identifier",
"text": "External Ids for this item",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.identifier.label",
"text": "label:",
"type": "string",
"required": false,
"repeats": false
},
{
"linkId": "Appointment.identifier.system",
"text": "system:",
"type": "string",
"required": false,
"repeats": false
},
{
"linkId": "Appointment.identifier.value",
"text": "value:",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "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. If the Appointment's status is \"cancelled\" then all participants are expected to have their calendars released for the appointment period, and as such any Slot's that were marked as BUSY can be re-set to FREE."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "code"
}
],
"linkId": "Appointment.status",
"required": true,
"repeats": true,
"question": [
{
"linkId": "Appointment.status.value",
"text": "status",
"type": "choice",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService)."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "CodeableConcept"
}
],
"linkId": "Appointment.type",
"text": "The type of appointment that is being booked",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.type.coding",
"text": "code:",
"type": "open-choice",
"required": false,
"repeats": false
},
{
"linkId": "Appointment.type.text",
"text": "text:",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The reason that this appointment is being scheduled, this is more clinical than administrative."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "CodeableConcept"
}
],
"linkId": "Appointment.reason",
"text": "The reason that this appointment is being scheduled, this is more clinical than administrative",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.reason.coding",
"text": "code:",
"type": "choice",
"required": false,
"repeats": false
},
{
"linkId": "Appointment.reason.text",
"text": "text:",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "integer"
}
],
"linkId": "Appointment.priority",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.priority.value",
"text": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)",
"type": "integer",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "Appointment.description",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.description.value",
"text": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field",
"type": "string",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Date/Time that the appointment is to take place."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "instant"
}
],
"linkId": "Appointment.start",
"required": true,
"repeats": true,
"question": [
{
"linkId": "Appointment.start.value",
"text": "Date/Time that the appointment is to take place",
"type": "instant",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Date/Time that the appointment is to conclude."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "instant"
}
],
"linkId": "Appointment.end",
"required": true,
"repeats": true,
"question": [
{
"linkId": "Appointment.end.value",
"text": "Date/Time that the appointment is to conclude",
"type": "instant",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "Appointment.slot",
"required": false,
"repeats": true,
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Slot?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "Appointment.slot.value",
"text": "The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot",
"type": "reference",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Additional comments about the appointment. Additional text to aid in facilitating the appointment. For instance, a comment might be, “patient should proceed immediately to infusion room upon arrival”."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "Appointment.comment",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.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": "An Order that lead to the creation of this appointment."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "Reference"
}
],
"linkId": "Appointment.order",
"required": false,
"repeats": true,
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Order?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "Appointment.order.value",
"text": "An Order that lead to the creation of this appointment",
"type": "reference",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "List of participants involved in the appointment."
}
],
"linkId": "Appointment.participant",
"title": "List of participants involved in the appointment",
"required": true,
"repeats": true,
"group": [
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "unique id for the element within a resource (for internal references)."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "string"
}
],
"linkId": "Appointment.participant.id",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.participant.id.value",
"text": "xml:id (or equivalent in JSON)",
"type": "string",
"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": "Appointment.participant.type",
"text": "Role of participant in the appointment",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.participant.type.coding",
"text": "code:",
"type": "choice",
"required": false,
"repeats": false
},
{
"linkId": "Appointment.participant.type.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": "Appointment.participant.actor",
"text": "A Person, Location/HealthcareService or Device that is participating in the appointment",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.participant.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": "Appointment.participant.actor._Patient",
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Patient?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "Appointment.participant.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": "Appointment.participant.actor._Practitioner",
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Practitioner?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "Appointment.participant.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": "Appointment.participant.actor._RelatedPerson",
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/RelatedPerson?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "Appointment.participant.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": "Appointment.participant.actor._Device",
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Device?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "Appointment.participant.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": "Appointment.participant.actor._HealthcareService",
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/HealthcareService?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "Appointment.participant.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": "Appointment.participant.actor._Location",
"question": [
{
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
"valueString": "/Location?subject=$subj&patient=$subj&encounter=$encounter"
}
],
"linkId": "Appointment.participant.actor._Location.value",
"text": "Location",
"type": "reference",
"required": false,
"repeats": false
}
]
}
]
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "code"
}
],
"linkId": "Appointment.participant.required",
"required": false,
"repeats": true,
"question": [
{
"linkId": "Appointment.participant.required.value",
"text": "required",
"type": "choice",
"required": false,
"repeats": false
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
"valueString": "Participation status of the Patient."
},
{
"url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
"valueString": "code"
}
],
"linkId": "Appointment.participant.status",
"required": true,
"repeats": true,
"question": [
{
"linkId": "Appointment.participant.status.value",
"text": "status",
"type": "choice",
"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.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4902) generated on Fri, Mar 27, 2015 00:17+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change