IHE ITI Scheduling, published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.8.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.Scheduling/ and changes regularly. See the Directory of published versions
: Book_Appointment_Operation - TTL Representation
Raw ttl | Download
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "appointment-book"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition appointment-book</b></p><a name=\"appointment-book\"> </a><a name=\"hcappointment-book\"> </a><a name=\"hcappointment-book-en\"> </a><p>URL: [base]/Appointment/$book</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>appointment-reference</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-ihe-sched-appt.html\" title=\"https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt\">IHE ITI Appointment Profile</a>)</td><td/><td><div><p>A resource id for one of proposed Appointments returned by a prior $find operation (e.g., Resource/1234). References can be to an absolute URL, but servers only perform this operation on their own appointments.</p>\n</div></td></tr><tr><td>IN</td><td>appointment-resource</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/appointment.html\">Appointment</a> (<a href=\"StructureDefinition-ihe-sched-appt.html\" title=\"https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt\">IHE ITI Appointment Profile</a>)</td><td/><td><div><p>The full appointment resource is needed for appontment change requests</p>\n</div></td></tr><tr><td>IN</td><td>patient-resource</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a> (<a href=\"http://hl7.org/fhir/uv/ipa/STU1/StructureDefinition-ipa-patient.html\" title=\"http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient\">IPA-Patient</a>)</td><td/><td><div><p>The Patient resource type is used to provide the patient information as known to the SHecduling client at the time of booking of the appointment.</p>\n</div></td></tr><tr><td>IN</td><td>comment</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The optional comment can be added for additional notes that may be useful for booking, canceling, or modfying an appointment</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a> (<a href=\"StructureDefinition-ihe-sched-avail-bundle.html\" title=\"https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle\">IHE ITI Scheduling Bundle Profile</a>)</td><td/><td><div><p>An <a href=\"StructureDefinition-ihe-sched-avail-bundle.html\">IHE ITI Scheduling Appointment Bundle Profile</a> of type <code>searchset</code> consisting of the requested booked Appointment resource and may also contain an OperationOutcome with errors, warnings or information as a result of processing the operation. The Appointment resource will have an updated <code>status</code> of "booked" if the book is approved or "cancelled" if the book is rejected.</p>\n</div></td></tr></table></div>"
] ; #
fhir:url [ fhir:v "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book"^^xsd:anyURI] ; #
fhir:version [ fhir:v "0.8.0-current"] ; #
fhir:name [ fhir:v "Book_Appointment_Operation"] ; #
fhir:status [ fhir:v "active"] ; #
fhir:kind [ fhir:v "operation"] ; #
fhir:date [ fhir:v "2024-02-05"^^xsd:date] ; #
fhir:publisher [ fhir:v "IHE IT Infrastructure Technical Committee"] ; #
fhir:contact ( [
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://www.ihe.net/ihe_domains/it_infrastructure/" ] ] )
] [
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "iti@ihe.net" ] ] )
] [
fhir:name [ fhir:v "IHE IT Infrastructure Technical Committee" ] ;
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "iti@ihe.net" ] ] )
] ) ; #
fhir:description [ fhir:v "Request to book a selected Appointment. This operation follows the appointment availability and optional hold interactions. This operaton completes the booking of an appointment. The server determines if the nominated appointment is still available (i.e., all the required actors and physical assets needed for the appointment are still available) and either accepts or rejects the hold request and updates the resource status accordingly. "] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;
fhir:code [ fhir:v "001" ] ] )
] ) ; #
fhir:code [ fhir:v "book"] ; #
fhir:resource ( [ fhir:v "Appointment"] ) ; #
fhir:system [ fhir:v "false"^^xsd:boolean] ; #
fhir:type [ fhir:v "true"^^xsd:boolean] ; #
fhir:instance [ fhir:v "false"^^xsd:boolean] ; #
fhir:parameter ( [
fhir:name [ fhir:v "appointment-reference" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "A resource id for one of proposed Appointments returned by a prior $find operation (e.g., Resource/1234). References can be to an absolute URL, but servers only perform this operation on their own appointments." ] ;
fhir:type [ fhir:v "Reference" ] ;
( fhir:targetProfile [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt"^^xsd:anyURI ;
fhir:link <https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt> ] )
] [
fhir:name [ fhir:v "appointment-resource" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The full appointment resource is needed for appontment change requests" ] ;
fhir:type [ fhir:v "Appointment" ] ;
( fhir:targetProfile [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt"^^xsd:anyURI ;
fhir:link <https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt> ] )
] [
fhir:name [ fhir:v "patient-resource" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "The Patient resource type is used to provide the patient information as known to the SHecduling client at the time of booking of the appointment." ] ;
fhir:type [ fhir:v "Patient" ] ;
( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient> ] )
] [
fhir:name [ fhir:v "comment" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The optional comment can be added for additional notes that may be useful for booking, canceling, or modfying an appointment" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "return" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "An [IHE ITI Scheduling Appointment Bundle Profile](StructureDefinition-ihe-sched-avail-bundle.html) of type `searchset` consisting of the requested booked Appointment resource and may also contain an OperationOutcome with errors, warnings or information as a result of processing the operation. The Appointment resource will have an updated `status` of \"booked\" if the book is approved or \"cancelled\" if the book is rejected." ] ;
fhir:type [ fhir:v "Bundle" ] ;
( fhir:targetProfile [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle"^^xsd:anyURI ;
fhir:link <https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle> ] )
] ) . #
|
Propose a change