{
"description": "Profile to describe the location and time for the fulfillment of the service request.\\nIn this resource, the status of the appointment is defined, patient-oriented instructions are listed here \\nand where and when the service request is to be fulfilled.",
"_filename": "StructureDefinition-ch-orf-appointment.json",
"package_name": "ch.fhir.ig.ch-orf",
"date": "2023-12-20T10:23:05+01:00",
"derivation": "constraint",
"publisher": "HL7 Switzerland",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "CH",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "ChOrfAppointment",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://ietf.org/rfc/2445",
"name": "iCalendar",
"identity": "ical"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"copyright": "CC0-1.0",
"type": "Appointment",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "CH ORF Appointment",
"package_version": "2.0.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "app-2",
"human": "Either start and end are specified, or neither",
"xpath": "((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))",
"source": "http://hl7.org/fhir/StructureDefinition/Appointment",
"severity": "error",
"expression": "start.exists() = end.exists()"
}, {
"key": "app-3",
"human": "Only proposed or cancelled appointments can be missing start/end dates",
"xpath": "((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled') or (f:status/@value='waitlist'))",
"source": "http://hl7.org/fhir/StructureDefinition/Appointment",
"severity": "error",
"expression": "(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))"
}, {
"key": "app-4",
"human": "Cancelation reason is only used for appointments that have been cancelled, or no-show",
"xpath": "not(exists(f:cancellationReason)) or f:status/@value=('no-show', 'cancelled')",
"source": "http://hl7.org/fhir/StructureDefinition/Appointment",
"severity": "error",
"expression": "Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')"
}, {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "Appointment",
"min": 0,
"definition": "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).",
"isModifier": false,
"short": "CH ORF Appointment",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Request",
"identity": "workflow"
}, {
"map": "Act[@moodCode <= 'INT']",
"identity": "rim"
}, {
"map": "VEVENT",
"identity": "ical"
} ],
"max": "*",
"id": "Appointment",
"base": {
"max": "*",
"min": 0,
"path": "Appointment"
},
"isSummary": false
}, {
"path": "Appointment.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"max": "1",
"id": "Appointment.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.meta",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Appointment.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.implicitRules",
"min": 0,
"definition": "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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Appointment.implicitRules",
"comment": "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"description": "A human language."
},
"max": "1",
"id": "Appointment.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.text",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Appointment.text",
"comment": "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 information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Appointment.contained",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Appointment.contained",
"comment": "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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Appointment.extension",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Appointment.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Appointment.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Appointment.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.identifier",
"min": 0,
"definition": "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).",
"isModifier": false,
"short": "External identifier for this item: May be used for referencing to a record in a scheduling application. Status in the scheduling application may \n change in time whereas Appointment.status reflects the status at the time the appointment is initiated.",
"mapping": [ {
"map": "Request.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "SCH-1, SCH-2, ARQ-1, ARQ-2",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "UID",
"identity": "ical"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "Appointment.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.status",
"min": 1,
"definition": "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.",
"isModifier": true,
"short": "Used to express if time and date are the preference of the patient (=\"proposed\"), confirmed by the patient but not yet by the service provider \n (=\"pending\") or confirmed by the patient and the service provider (=\"booked\")",
"mapping": [ {
"map": "Request.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "SCH-25",
"identity": "v2"
}, {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "STATUS",
"identity": "ical"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-appointmentstatus"
},
"max": "1",
"id": "Appointment.status",
"comment": "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 Slots that were marked as BUSY can be re-set to FREE.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "Appointment.status"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.cancelationReason",
"min": 0,
"definition": "The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.",
"isModifier": false,
"short": "The coded reason for the appointment being cancelled",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/appointment-cancellation-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "cancelation-reason"
} ]
},
"max": "1",
"id": "Appointment.cancelationReason",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.cancelationReason"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.serviceCategory",
"min": 0,
"definition": "A broad categorization of the service that is to be performed during this appointment.",
"isModifier": false,
"short": "A broad categorization of the service that is to be performed during this appointment",
"mapping": [ {
"map": "n/a, might be inferred from the ServiceDeliveryLocation",
"identity": "rim"
}, {
"map": "CATEGORIES",
"identity": "ical"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/service-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-category"
} ]
},
"max": "*",
"id": "Appointment.serviceCategory",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.serviceCategory"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.serviceType",
"min": 0,
"definition": "The specific service that is to be performed during this appointment.",
"isModifier": false,
"short": "The specific service that is to be performed during this appointment",
"mapping": [ {
"map": "Request.code",
"identity": "workflow"
}, {
"map": "n/a, might be inferred from the ServiceDeliveryLocation",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/service-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-type"
} ]
},
"max": "*",
"id": "Appointment.serviceType",
"comment": "For a provider to provider appointment the code \"FOLLOWUP\" may be appropriate, as this is expected to be discussing some patient that was seen in the past.",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.serviceType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.specialty",
"min": 0,
"definition": "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"isModifier": false,
"short": "The specialty of a practitioner that would be required to perform the service requested in this appointment",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": ".performer.AssignedPerson.code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "specialty"
} ]
},
"max": "*",
"id": "Appointment.specialty",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.specialty"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.appointmentType",
"min": 0,
"definition": "The style of appointment or patient that has been booked in the slot (not service type).",
"isModifier": false,
"short": "The style of appointment or patient that has been booked in the slot (not service type)",
"mapping": [ {
"map": "ARQ-7",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "CLASSIFICATION",
"identity": "ical"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0276",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "appointment-type"
} ]
},
"max": "1",
"id": "Appointment.appointmentType",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.appointmentType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.reasonCode",
"min": 0,
"definition": "The coded reason that this appointment is being scheduled. This is more clinical than administrative.",
"isModifier": false,
"short": "Coded reason this appointment is scheduled",
"mapping": [ {
"map": "Request.reasonCode",
"identity": "workflow"
}, {
"map": "AIS-3, SCH-7",
"identity": "v2"
}, {
"map": ".reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/encounter-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ApptReason"
} ],
"description": "The Reason for the appointment to take place."
},
"max": "*",
"id": "Appointment.reasonCode",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.reasonCode"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.reasonReference",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Reason the appointment is to take place (resource)",
"mapping": [ {
"map": "Request.reasonReference",
"identity": "workflow"
}, {
"map": ".inboundRelationship[@typeCode = 'RSON'].observation",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" ]
} ],
"max": "*",
"id": "Appointment.reasonReference",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.reasonReference"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.priority",
"min": 0,
"definition": "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).",
"isModifier": false,
"short": "Used to make informed decisions if needing to re-prioritize",
"mapping": [ {
"map": "Request.priority",
"identity": "workflow"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "ARQ-12, SCH-11.6 / TQ1-9",
"identity": "v2"
}, {
"map": ".priorityCode",
"identity": "rim"
}, {
"map": "PRIORITY",
"identity": "ical"
} ],
"type": [ {
"code": "unsignedInt"
} ],
"max": "1",
"id": "Appointment.priority",
"comment": "Seeking implementer feedback on this property and how interoperable it is.\r\rUsing an extension to record a CodeableConcept for named values may be tested at a future connectathon.",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.priority"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.description",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Shown on a subject line in a meeting request, or appointment list",
"mapping": [ {
"map": "NTE-3",
"identity": "v2"
}, {
"map": ".text",
"identity": "rim"
}, {
"map": "SUMMARY",
"identity": "ical"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Appointment.description",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.supportingInformation",
"min": 0,
"definition": "Additional information to support the appointment provided when making the appointment.",
"isModifier": false,
"short": "Additional information to support the appointment",
"mapping": [ {
"map": "Request.supportingInfo",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": ".inboundRelationship[@typeCode = 'SPRT'].observation",
"identity": "rim"
}, {
"map": "ATTACH",
"identity": "ical"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "*",
"id": "Appointment.supportingInformation",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.supportingInformation"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.start",
"min": 0,
"definition": "Date/Time that the appointment is to take place.",
"isModifier": false,
"short": "When appointment is to take place (required if status=\"pending\" or \"booked\")",
"mapping": [ {
"map": "Request.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.init",
"identity": "w5"
}, {
"map": "ARQ-11.1, SCH-11.4 / TQ1-7",
"identity": "v2"
}, {
"map": ".effectiveTime.low",
"identity": "rim"
}, {
"map": "DTSTART",
"identity": "ical"
} ],
"type": [ {
"code": "instant"
} ],
"mustSupport": true,
"max": "1",
"id": "Appointment.start",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.start"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.end",
"min": 0,
"definition": "Date/Time that the appointment is to conclude.",
"isModifier": false,
"short": "When appointment is to conclude (required if status=\"pending\" or \"booked\")",
"mapping": [ {
"map": "Request.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.done[x]",
"identity": "w5"
}, {
"map": "SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9",
"identity": "v2"
}, {
"map": ".effectiveTime.high",
"identity": "rim"
}, {
"map": "DTEND",
"identity": "ical"
} ],
"type": [ {
"code": "instant"
} ],
"mustSupport": true,
"max": "1",
"id": "Appointment.end",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.end"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.minutesDuration",
"min": 0,
"definition": "Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.",
"isModifier": false,
"short": "Can be less than start/end (e.g. estimate)",
"mapping": [ {
"map": "Request.occurrence[x]",
"identity": "workflow"
}, {
"map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width",
"identity": "rim"
}, {
"map": "DURATION (e.g. PT15M)",
"identity": "ical"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "Appointment.minutesDuration",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.minutesDuration"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.slot",
"min": 0,
"definition": "The slots from the participants' schedules that will be filled by the appointment.",
"isModifier": false,
"short": "The slots that this appointment is filling",
"mapping": [ {
"map": ".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Slot" ]
} ],
"max": "*",
"id": "Appointment.slot",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.slot"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.created",
"min": 0,
"definition": "The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.",
"isModifier": false,
"short": "The date that this appointment was initially created",
"mapping": [ {
"map": "Request.authoredOn",
"identity": "workflow"
}, {
"map": ".author.time",
"identity": "rim"
}, {
"map": "CREATED",
"identity": "ical"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Appointment.created",
"comment": "This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.created"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.comment",
"min": 0,
"definition": "Additional comments about the appointment.",
"isModifier": false,
"short": "Additional comments",
"mapping": [ {
"map": "Request.note",
"identity": "workflow"
}, {
"map": "NTE-3",
"identity": "v2"
}, {
"map": ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value",
"identity": "rim"
}, {
"map": "DESCRIPTION (for internal use)",
"identity": "ical"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Appointment.comment",
"comment": "Additional text to aid in facilitating the appointment. For instance, a comment might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.comment"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.patientInstruction",
"min": 0,
"definition": "While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).",
"isModifier": false,
"short": "Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction",
"mapping": [ {
"map": "NTE-3",
"identity": "v2"
}, {
"map": ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value",
"identity": "rim"
}, {
"map": "DESCRIPTION (for patient use)",
"identity": "ical"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Appointment.patientInstruction",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.patientInstruction"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.basedOn",
"min": 0,
"definition": "The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).",
"isModifier": false,
"short": "The service request this appointment is allocated to assess",
"mapping": [ {
"map": "Request.basedOn",
"identity": "workflow"
}, {
"map": ".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ]
} ],
"alias": [ "incomingReferral" ],
"max": "*",
"id": "Appointment.basedOn",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.basedOn"
},
"isSummary": false
}, {
"constraint": [ {
"key": "app-1",
"human": "Either the type or actor on the participant SHALL be specified",
"xpath": "(exists(f:type) or exists(f:actor))",
"source": "http://hl7.org/fhir/StructureDefinition/Appointment",
"severity": "error",
"expression": "type.exists() or actor.exists()"
}, {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.participant",
"min": 1,
"definition": "List of participants involved in the appointment.",
"isModifier": false,
"short": "Participants involved in appointment",
"mapping": [ {
"map": "Request.performer, Request.subject",
"identity": "workflow"
}, {
"map": "PID, AIP, AIG, AIL",
"identity": "v2"
}, {
"map": "performer | reusableDevice | subject | location",
"identity": "rim"
}, {
"map": "ATTENDEE component to be created",
"identity": "ical"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "1",
"id": "Appointment.participant",
"base": {
"max": "*",
"min": 1,
"path": "Appointment.participant"
},
"isSummary": false
}, {
"path": "Appointment.participant.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Appointment.participant.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Appointment.participant.extension",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Appointment.participant.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Appointment.participant.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Appointment.participant.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.participant.type",
"min": 0,
"definition": "Role of participant in the appointment.",
"isModifier": false,
"short": "Role of participant in the appointment",
"mapping": [ {
"map": "AIP-4, AIG-4",
"identity": "v2"
}, {
"map": "(performer | reusableDevice | subject | location).@typeCode",
"identity": "rim"
}, {
"map": "n/a",
"identity": "ical"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/encounter-participant-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParticipantType"
} ],
"description": "Role of participant in encounter."
},
"max": "*",
"id": "Appointment.participant.type",
"comment": "The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.\r\rIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\r\rThis value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.participant.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.participant.actor",
"min": 0,
"definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"isModifier": false,
"short": "Name, address and telecom of the appointment location",
"mapping": [ {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3",
"identity": "v2"
}, {
"map": "performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation",
"identity": "rim"
}, {
"map": "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not \"information-only\"",
"identity": "ical"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-location" ]
} ],
"mustSupport": true,
"max": "1",
"id": "Appointment.participant.actor",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.participant.actor"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.participant.required",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "required | optional | information-only",
"mapping": [ {
"map": "(performer | reusableDevice | subject | location).@performInd",
"identity": "rim"
}, {
"map": "ROLE=REQ-PARTICIPANT (roleparam)",
"identity": "ical"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/participantrequired|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParticipantRequired"
} ],
"description": "Is the Participant required to attend the appointment."
},
"max": "1",
"id": "Appointment.participant.required",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.participant.required"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.participant.status",
"min": 1,
"definition": "Participation status of the actor.",
"isModifier": false,
"short": "accepted | declined | tentative | needs-action",
"mapping": [ {
"map": "AIP-12, AIG-14",
"identity": "v2"
}, {
"map": "(performer | reusableDevice | subject | location).statusCode",
"identity": "rim"
}, {
"map": "ATTENDEE;CN=\"John Doe\";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)",
"identity": "ical"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"patternCode": "tentative",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/participationstatus|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParticipationStatus"
} ],
"description": "The Participation status of an appointment."
},
"max": "1",
"id": "Appointment.participant.status",
"base": {
"max": "1",
"min": 1,
"path": "Appointment.participant.status"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.participant.period",
"min": 0,
"definition": "Participation period of the actor.",
"isModifier": false,
"short": "Participation period of the actor",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Appointment.participant.period",
"base": {
"max": "1",
"min": 0,
"path": "Appointment.participant.period"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.requestedPeriod",
"min": 0,
"definition": "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.\n\nThe 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.",
"isModifier": false,
"short": "Single Date/time or Date/time-interval indication for the appointment with the status=\"proposed\". A single Date/time indication MUST have \n the same value for start and end.",
"mapping": [ {
"map": "Request.occurrence[x]",
"identity": "workflow"
}, {
"map": "ARQ-11",
"identity": "v2"
}, {
"map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": true,
"max": "1",
"id": "Appointment.requestedPeriod",
"comment": "This does not introduce a capacity for recurring appointments.",
"base": {
"max": "*",
"min": 0,
"path": "Appointment.requestedPeriod"
},
"isSummary": false
}, {
"path": "Appointment.requestedPeriod.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Appointment.requestedPeriod.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Appointment.requestedPeriod.extension",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Appointment.requestedPeriod.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.requestedPeriod.start",
"min": 0,
"definition": "The start of the period. The boundary is inclusive.",
"isModifier": false,
"short": "Starting time with inclusive boundary",
"mapping": [ {
"map": "DR.1",
"identity": "v2"
}, {
"map": "./low",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": true,
"max": "1",
"id": "Appointment.requestedPeriod.start",
"condition": [ "per-1" ],
"comment": "If the low element is missing, the meaning is that the low boundary is not known.",
"base": {
"max": "1",
"min": 0,
"path": "Period.start"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Appointment.requestedPeriod.end",
"min": 0,
"definition": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"isModifier": false,
"short": "End time with inclusive boundary, if not ongoing",
"mapping": [ {
"map": "DR.2",
"identity": "v2"
}, {
"map": "./high",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": true,
"meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing",
"max": "1",
"id": "Appointment.requestedPeriod.end",
"condition": [ "per-1" ],
"comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.",
"base": {
"max": "1",
"min": 0,
"path": "Period.end"
},
"isSummary": true
} ]
},
"status": "active",
"id": "bc463969-3a5c-44ae-9694-94ab7c095d44",
"kind": "resource",
"url": "http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-appointment",
"version": "2.0.0",
"differential": {
"element": [ {
"id": "Appointment",
"path": "Appointment",
"short": "CH ORF Appointment"
}, {
"id": "Appointment.identifier",
"path": "Appointment.identifier",
"short": "External identifier for this item: May be used for referencing to a record in a scheduling application. Status in the scheduling application may \n change in time whereas Appointment.status reflects the status at the time the appointment is initiated.",
"mustSupport": true
}, {
"id": "Appointment.status",
"path": "Appointment.status",
"short": "Used to express if time and date are the preference of the patient (=\"proposed\"), confirmed by the patient but not yet by the service provider \n (=\"pending\") or confirmed by the patient and the service provider (=\"booked\")",
"binding": {
"strength": "required",
"valueSet": "http://fhir.ch/ig/ch-orf/ValueSet/ch-orf-vs-appointmentstatus"
},
"mustSupport": true
}, {
"id": "Appointment.start",
"path": "Appointment.start",
"short": "When appointment is to take place (required if status=\"pending\" or \"booked\")",
"mustSupport": true
}, {
"id": "Appointment.end",
"path": "Appointment.end",
"short": "When appointment is to conclude (required if status=\"pending\" or \"booked\")",
"mustSupport": true
}, {
"id": "Appointment.patientInstruction",
"path": "Appointment.patientInstruction",
"short": "Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction",
"mustSupport": true
}, {
"id": "Appointment.participant",
"max": "1",
"path": "Appointment.participant",
"mustSupport": true
}, {
"id": "Appointment.participant.actor",
"path": "Appointment.participant.actor",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-location" ]
} ],
"short": "Name, address and telecom of the appointment location",
"mustSupport": true
}, {
"id": "Appointment.participant.status",
"path": "Appointment.participant.status",
"mustSupport": true,
"patternCode": "tentative"
}, {
"id": "Appointment.requestedPeriod",
"max": "1",
"path": "Appointment.requestedPeriod",
"short": "Single Date/time or Date/time-interval indication for the appointment with the status=\"proposed\". A single Date/time indication MUST have \n the same value for start and end.",
"mustSupport": true
}, {
"id": "Appointment.requestedPeriod.start",
"path": "Appointment.requestedPeriod.start",
"mustSupport": true
}, {
"id": "Appointment.requestedPeriod.end",
"path": "Appointment.requestedPeriod.end",
"mustSupport": true
} ]
},
"contact": [ {
"name": "HL7 Switzerland",
"telecom": [ {
"value": "https://www.hl7.ch/",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Appointment"
}