This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions
Patient Administration Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Patient, Practitioner, RelatedPerson |
Generated Questionnaire for Schedule
{ "resourceType": "Questionnaire", "id": "qs1", "contained": [ { "resourceType": "ValueSet", "id": "vs2", "name": "Type options for Schedule.actor", "status": "active", "description": "Type options for Schedule.actor", "expansion": { "identifier": "urn:uuid:d92537eb-3df0-4392-9683-b27e45846322", "timestamp": "2019-10-24T11:53:00+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": "PractitionerRole", "display": "PractitionerRole" }, { "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": "2019-10-24T11:53:00+11:00", "publisher": "Health Level Seven International (Patient Administration)", "item": [ { "linkId": "Schedule", "text": "A container for slots of time that may be available for booking appointments", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "A container for slots of time that may be available for booking appointments.", "type": "display" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs", "valueInteger": 1 }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "string" } ], "linkId": "Schedule.id", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "The logical id of the resource, as used in the URL for the resource. 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.", "type": "display" }, { "linkId": "Schedule.id.value", "text": "Logical id of this artifact", "type": "string", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs", "valueInteger": 1 } ], "linkId": "Schedule.meta", "text": "Metadata about the resource", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "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.", "type": "display" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs", "valueInteger": 1 }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "uri" } ], "linkId": "Schedule.implicitRules", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "type": "display" }, { "linkId": "Schedule.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/StructureDefinition/questionnaire-maxOccurs", "valueInteger": 1 }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "code" } ], "linkId": "Schedule.language", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "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 Not 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).", "type": "display" }, { "linkId": "Schedule.language.value", "text": "language", "type": "choice", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs", "valueInteger": 1 } ], "linkId": "Schedule.text", "text": "Text summary of the resource, for human interpretation", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "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. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.", "type": "display" } ] }, { "linkId": "Schedule.contained", "text": "Contained, inline Resources", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "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.", "type": "display" } ] }, { "linkId": "Schedule.extension", "text": "Additional Content defined by implementations", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "type": "display" } ] }, { "linkId": "Schedule.modifierExtension", "text": "Extensions that cannot be ignored", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "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. Usually modifier elements provide negation or qualification. In order 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "type": "display" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "Identifier" } ], "linkId": "Schedule.identifier", "text": "External Ids for this item", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "External Ids for this item.", "type": "display" }, { "linkId": "Schedule.identifier.label", "text": "label:", "type": "string", "required": false, "repeats": false }, { "linkId": "Schedule.identifier.system", "text": "system:", "type": "string", "required": false, "repeats": false }, { "linkId": "Schedule.identifier.value", "text": "value:", "type": "string", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs", "valueInteger": 1 }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "boolean" } ], "linkId": "Schedule.active", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "Whether this schedule record is in active use, or should not be used (such as was entered in error). This element is labeled as a modifier because it may be used to mark that the resource was created in error.", "type": "display" }, { "linkId": "Schedule.active.value", "text": "Whether this schedule is in active use", "type": "boolean", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs", "valueInteger": 1 }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "CodeableConcept" } ], "linkId": "Schedule.serviceCategory", "text": "A broad categorisation of the service that is to be performed during this appointment", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "A broad categorisation of the service that is to be performed during this appointment.", "type": "display" }, { "linkId": "Schedule.serviceCategory.coding", "text": "code:", "type": "open-choice", "required": false, "repeats": false }, { "linkId": "Schedule.serviceCategory.text", "text": "text:", "type": "string", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "CodeableConcept" } ], "linkId": "Schedule.serviceType", "text": "The specific service that is to be performed during this appointment", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "The specific service that is to be performed during this appointment.", "type": "display" }, { "linkId": "Schedule.serviceType.coding", "text": "code:", "type": "open-choice", "required": false, "repeats": false }, { "linkId": "Schedule.serviceType.text", "text": "text:", "type": "string", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "CodeableConcept" } ], "linkId": "Schedule.specialty", "text": "The specialty of a practitioner that would be required to perform the service requested in this appointment", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "The specialty of a practitioner that would be required to perform the service requested in this appointment.", "type": "display" }, { "linkId": "Schedule.specialty.coding", "text": "code:", "type": "open-choice", "required": false, "repeats": false }, { "linkId": "Schedule.specialty.text", "text": "text:", "type": "string", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs", "valueInteger": 1 } ], "linkId": "Schedule.actor", "text": "The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson", "type": "group", "required": true, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson. The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a pracitioner and a room(location) are always required by a system.", "type": "display" }, { "linkId": "Schedule.actor._type", "text": "type", "type": "choice", "required": false, "repeats": false, "options": { "reference": "#vs2" }, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "Reference" } ], "linkId": "Schedule.actor._Patient", "type": "group", "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource", "valueCode": "Patient" }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter", "valueString": "subject=$subj&patient=$subj&encounter=$encounter" } ], "linkId": "Schedule.actor._Patient.value", "text": "Patient", "type": "reference", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "Reference" } ], "linkId": "Schedule.actor._Practitioner", "type": "group", "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource", "valueCode": "Practitioner" }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter", "valueString": "subject=$subj&patient=$subj&encounter=$encounter" } ], "linkId": "Schedule.actor._Practitioner.value", "text": "Practitioner", "type": "reference", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "Reference" } ], "linkId": "Schedule.actor._PractitionerRole", "type": "group", "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource", "valueCode": "PractitionerRole" }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter", "valueString": "subject=$subj&patient=$subj&encounter=$encounter" } ], "linkId": "Schedule.actor._PractitionerRole.value", "text": "PractitionerRole", "type": "reference", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "Reference" } ], "linkId": "Schedule.actor._RelatedPerson", "type": "group", "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource", "valueCode": "RelatedPerson" }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter", "valueString": "subject=$subj&patient=$subj&encounter=$encounter" } ], "linkId": "Schedule.actor._RelatedPerson.value", "text": "RelatedPerson", "type": "reference", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "Reference" } ], "linkId": "Schedule.actor._Device", "type": "group", "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource", "valueCode": "Device" }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter", "valueString": "subject=$subj&patient=$subj&encounter=$encounter" } ], "linkId": "Schedule.actor._Device.value", "text": "Device", "type": "reference", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "Reference" } ], "linkId": "Schedule.actor._HealthcareService", "type": "group", "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource", "valueCode": "HealthcareService" }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter", "valueString": "subject=$subj&patient=$subj&encounter=$encounter" } ], "linkId": "Schedule.actor._HealthcareService.value", "text": "HealthcareService", "type": "reference", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "Reference" } ], "linkId": "Schedule.actor._Location", "type": "group", "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource", "valueCode": "Location" }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter", "valueString": "subject=$subj&patient=$subj&encounter=$encounter" } ], "linkId": "Schedule.actor._Location.value", "text": "Location", "type": "reference", "required": false, "repeats": false } ] } ] } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs", "valueInteger": 1 }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "Period" } ], "linkId": "Schedule.planningHorizon", "text": "The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a \"template\" for planning outside these dates", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a \"template\" for planning outside these dates.", "type": "display" }, { "linkId": "Schedule.planningHorizon.low", "text": "start:", "type": "dateTime", "required": false, "repeats": false }, { "linkId": "Schedule.planningHorizon.end", "text": "end:", "type": "dateTime", "required": false, "repeats": false } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs", "valueInteger": 1 }, { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType", "valueString": "string" } ], "linkId": "Schedule.comment", "type": "group", "required": false, "repeats": true, "item": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/questionnaire-item-control", "code": "flyover", "display": "Fly-over" } ] } } ], "text": "Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.", "type": "display" }, { "linkId": "Schedule.comment.value", "text": "Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated", "type": "string", "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.