Workflow
HL7 Norway proposed base profiles for Workflow resources in HL7 FHIR R4.
Only attributes with actual profiling is included in the information model diagram as well as any optional extensions provided as a part of the no-basis package. The model should be forward compatible to Appointment in R5 as far as possible.
Short notice on relationship between no-basis Appointment and no-basis-Encounter
Appointment and Encounter have dependencies as they both describe different aspects of the administrative relationship between patient and health care organizations.
Appointment (no:timeavtale; npr:planlagt episode) – describes a planned meeting between a patient and healthcare personell.
Encounter (no: kontakt, besøk, opphold, innleggelse, omsorgsepisode, poliklinisk konsultasjon etc) is defined as: “An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient”. An inpatient encounter (no:inneliggende) is an encounter that can consist of several sub-encounters – for example a radiology examination or a surgery. The national base profile have defined an extension in no-basis-Appointment to mirror this partOf-pattern in the encounter.
The normal scenario is that the Appointment resource is used until the patient is registered as arrived. After arrival the Encounter resource is used to share information about the interaction. Due to the fact that the Encounter resource contains more clinical related information than Appointment, some EHRs may use Encounter with status planned to share information about the interaction also before the patient is registered as arrived.
Inspection (no: tilsyn) are normally not registered as independent encounters in the EHR, but represents and interaction between patient and healthcare personell that is documented in an inspection note (no: tilsynsnotat). Local routines as each hospital can choose to register inspections as encounters, but in most cases such a practice will require too much manual registration in the EHR. An inspection can also be registered as a procedure.
EpisodeOfCare (no: henvisningsperiode) can encompass several ambulatory and inpatient encounters across several organizations. The challenge with tracing such patient trajectory (no: pasientforløp) is that the episode of care will encompass several service requests (no: henvisninger) and there are no common identifier that can be used to trace the patient trajectory across these encounters. Helsedirektoratet has earlier pointed to the need for such an identifier (forløpsidentifikator).
no-basis-Appointment
Base profile for Norwegian Appointment information. Defined by HL7 Norway. This profile identifies a set of minimum expectations for an Appointment resource when creating, searching and retrieving compositions by defining which coding system(s) must be present when using this profile.
The base profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
The full documentation of the profile no-basis-Appointment
Resource content
NoBasisAppointment (Appointment) | I | Appointment | There are no (further) constraints on this element Element idAppointment 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) DefinitionA 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).
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idAppointment.id Logical id of this artifact DefinitionThe 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. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAppointment.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAppointment.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.language Language of the resource content DefinitionThe 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idAppointment.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idAppointment.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.extension Extension DefinitionAn Extension Unordered, Open, by url(Value) Constraints
|
virtualService | I | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idAppointment.extension:virtualService Virtual Service DefinitionThe VirtualService structure defines details of a virtual communication capability, such as a web conference call. Extension(Complex) Extension URLhttp://hl7.no/fhir/StructureDefinition/no-basis-virtual-service Constraints
|
group | I | 0..1 | Extension(boolean) | There are no (further) constraints on this element Element idAppointment.extension:group no-basis-group DefinitionThe appointment is a group session. http://hl7.no/fhir/StructureDefinition/no-basis-group Constraints
|
partOf | I | 0..1 | Extension(Reference(NoBasisAppointment)) | There are no (further) constraints on this element Element idAppointment.extension:partOf no-basis-partof DefinitionThis basis extension mirrors the Encounter.partOF-attribute. The partOf-attribute enables booking of a set of related appointments with a set of sub-appointments being linked to the main appointment in the same way as encounters are being linked. A larger appointment of which this particular appointment is a component or step. Extension(Reference(NoBasisAppointment)) Extension URLhttp://hl7.no/fhir/StructureDefinition/no-basis-partof Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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.
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idAppointment.identifier External Ids for this item DefinitionThis 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).
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.status proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist DefinitionThe overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid. The free/busy status of an appointment.
|
cancelationReason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idAppointment.cancelationReason The coded reason for the appointment being cancelled DefinitionThe 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. AppointmentCancellationReason (example) Constraints
|
serviceCategory | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAppointment.serviceCategory A broad categorization of the service that is to be performed during this appointment DefinitionA broad categorization of the service that is to be performed during this appointment.
|
serviceType | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAppointment.serviceType The specific service that is to be performed during this appointment DefinitionThe specific service that is to be performed during this appointment. 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.
|
specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.specialty The specialty of a practitioner that would be required to perform the service requested in this appointment DefinitionThe specialty of a practitioner that would be required to perform the service requested in this appointment. PracticeSettingCodeValueSet (preferred) Constraints
|
appointmentType | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.appointmentType The style of appointment or patient that has been booked in the slot (not service type) DefinitionThe style of appointment or patient that has been booked in the slot (not service type).
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.appointmentType.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.appointmentType.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idAppointment.appointmentType.coding Recomended code systems for no-basis-Appointment. DefinitionRecomended code systems for no-basis-Appointment. The recomended code systems might not be suficient for defining appointment type and in an implemented profile - some other coding might be needed. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Value) Constraints
|
omsorgsNiva | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAppointment.appointmentType.coding:omsorgsNiva Volven 8406 DefinitionOmsorgsnivå (OID=8406). Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Volven
|
kontaktType | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAppointment.appointmentType.coding:kontaktType Volven 8432 DefinitionKontakttype (OID=8432) Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Volven
|
innbygger | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAppointment.appointmentType.coding:innbygger Volven 7617 DefinitionTimetype innbyggerportal (OID=7617) Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Volven
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idAppointment.appointmentType.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
reasonCode | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.reasonCode Coded reason this appointment is scheduled DefinitionThe coded reason that this appointment is being scheduled. This is more clinical than administrative. The Reason for the appointment to take place.
|
reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | There are no (further) constraints on this element Element idAppointment.reasonReference Reason the appointment is to take place (resource) DefinitionReason 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. Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Constraints
| |
priority | 0..1 | unsignedInt | There are no (further) constraints on this element Element idAppointment.priority Used to make informed decisions if needing to re-prioritize DefinitionThe 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). Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.
| |
description | 0..1 | string | There are no (further) constraints on this element Element idAppointment.description Shown on a subject line in a meeting request, or appointment list DefinitionThe 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.
| |
supportingInformation | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idAppointment.supportingInformation Additional information to support the appointment DefinitionAdditional information to support the appointment provided when making the appointment.
| |
start | Σ | 0..1 | instant | There are no (further) constraints on this element Element idAppointment.start When appointment is to take place DefinitionDate/Time that the appointment is to take place.
|
end | Σ | 0..1 | instant | There are no (further) constraints on this element Element idAppointment.end When appointment is to conclude DefinitionDate/Time that the appointment is to conclude.
|
minutesDuration | 0..1 | positiveInt | There are no (further) constraints on this element Element idAppointment.minutesDuration Can be less than start/end (e.g. estimate) DefinitionNumber 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.
| |
slot | 0..* | Reference(Slot) | There are no (further) constraints on this element Element idAppointment.slot The slots that this appointment is filling DefinitionThe slots from the participants' schedules that will be filled by the appointment.
| |
created | 0..1 | dateTime | There are no (further) constraints on this element Element idAppointment.created The date that this appointment was initially created DefinitionThe 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. 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.
| |
comment | 0..1 | string | There are no (further) constraints on this element Element idAppointment.comment Additional comments DefinitionAdditional comments about the appointment. Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where 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.
| |
patientInstruction | 0..1 | string | There are no (further) constraints on this element Element idAppointment.patientInstruction Detailed information and instructions for the patient DefinitionWhile 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).
| |
basedOn | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idAppointment.basedOn The service request this appointment is allocated to assess Alternate namesincomingReferral DefinitionThe service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
| |
participant | I | 1..* | BackboneElement | There are no (further) constraints on this element Element idAppointment.participant Participants involved in appointment DefinitionList of participants involved in the appointment.
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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 | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.participant.type Role of participant in the appointment DefinitionRole of participant in the appointment. The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. Role of participant in encounter.
|
actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | There are no (further) constraints on this element Element idAppointment.participant.actor Person, Location/HealthcareService or Device DefinitionA Person, Location/HealthcareService or Device that is participating in the appointment. Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Constraints
|
required | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.required required | optional | information-only DefinitionWhether 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. Is the Participant required to attend the appointment.
|
status | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.status accepted | declined | tentative | needs-action DefinitionParticipation status of the actor. The Participation status of an appointment.
|
period | 0..1 | Period | There are no (further) constraints on this element Element idAppointment.participant.period Participation period of the actor DefinitionParticipation period of the actor.
| |
requestedPeriod | 0..* | Period | There are no (further) constraints on this element Element idAppointment.requestedPeriod Potential date/time interval(s) requested to allocate the appointment within DefinitionA set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The 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. This does not introduce a capacity for recurring appointments.
|
no-basis-AppointmentResponse
Base profile for Norwegian AppointmentResponse information. Defined by HL7 Norway. Should be used as a basis for further profiling in use-cases where specific appointment response information is needed. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
The full documentation of the profile no-basis-AppointmentResponse
Resource content
NoBasisAppointmentResponse (AppointmentResponse) | I | AppointmentResponse | There are no (further) constraints on this element Element idAppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection DefinitionA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idAppointmentResponse.id Logical id of this artifact DefinitionThe 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. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAppointmentResponse.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAppointmentResponse.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointmentResponse.language Language of the resource content DefinitionThe 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idAppointmentResponse.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idAppointmentResponse.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointmentResponse.extension Extension DefinitionAn Extension Unordered, Open, by url(Value) Constraints
|
shortNotice | I | 0..1 | Extension(boolean) | There are no (further) constraints on this element Element idAppointmentResponse.extension:shortNotice no-basis-shortnotice DefinitionPatient can come on short notice. http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointmentResponse.extension:shortNotice.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idAppointmentResponse.extension:shortNotice.extension Extension DefinitionAn Extension Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idAppointmentResponse.extension:shortNotice.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idAppointmentResponse.extension:shortNotice.value[x] Patient can come on short notice. DefinitionPatient can come on short notice. Response is boolean
| ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idAppointmentResponse.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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.
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idAppointmentResponse.identifier External Ids for this item DefinitionThis records identifiers associated with this appointment response 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.
|
appointment | Σ | 1..1 | Reference(Appointment) | There are no (further) constraints on this element Element idAppointmentResponse.appointment Appointment this response relates to DefinitionAppointment that this response is replying to.
|
start | 0..1 | instant | There are no (further) constraints on this element Element idAppointmentResponse.start Time from appointment, or requested new start time DefinitionDate/Time that the appointment is to take place, or requested new start time. This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the start time.
| |
end | 0..1 | instant | There are no (further) constraints on this element Element idAppointmentResponse.end Time from appointment, or requested new end time DefinitionThis may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
| |
participantType | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointmentResponse.participantType Role of participant in the appointment DefinitionRole of participant in the appointment. The role of the participant can be used to declare what the actor will be doing in the scope of the referenced appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated. Role of participant in encounter.
|
actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | There are no (further) constraints on this element Element idAppointmentResponse.actor Person, Location, HealthcareService, or Device DefinitionA Person, Location, HealthcareService, or Device that is participating in the appointment. Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Constraints
|
participantStatus | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointmentResponse.participantStatus accepted | declined | tentative | needs-action DefinitionParticipation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty. This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid. The Participation status of an appointment.
|
comment | 0..1 | string | There are no (further) constraints on this element Element idAppointmentResponse.comment Additional comments DefinitionAdditional comments about the appointment. This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.
|