Tiempos de Espera Interoperable
0.2.1 - draft
Tiempos de Espera Interoperable, published by Unidad de Interoperabilidad - MINSAL. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Minsal-CL/SIGTEv2-IG/ and changes regularly. See the Directory of published versions
Official URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/AppointmentAgendarLE | Version: 0.2.1 | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: AppointmentAgendarLE |
Appointment Agendar LE
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Appointment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | 0..* | Appointment | 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) | |
id | S | 1..1 | id | Id temporal necesario para identificar el recurso |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionMediodeContacto | S | 0..1 | CodeableConcept | Medio por donde se notificó al paciente URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/ExtensionMediodeContacto Binding: Medio Notificación (required) |
ExtensionContactadoLE | S | 1..1 | (Complex) | Extensión compleja, donde se indica si el paciente fue Contactado[true|false] o MotivoNoContactabilidad si la anterior fue false URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/Contactado |
identifier | S | 1..1 | Identifier | ID del identificador de la cita |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | Valor del Id |
status | S | 1..1 | code | Se considera el uso de SOLO estos estados: pending=pendiente | booked=cita agendada | cancelled=cita cancelada | noshow=no presentación |
cancelationReason | S | 0..1 | CodeableConcept | Uso en caso de cancelación de cita para registrar la razón |
coding | S | 1..1 | Coding | Códigos definidos por un sistema terminológico |
system | S | 1..1 | uri | Sistema terminológico, url/uri/uuid Required Pattern: http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason |
code | S | 1..1 | code | Código definido en un sistema terminológico, para este caso se consideran los siguientes: pat(paciente) | prov(médico o institución) | other(otra razón) |
display | S | 0..1 | string | Representación visual del concepto definido por el sistema terminológico |
appointmentType | S | 0..1 | CodeableConcept | El estilo de cita médica o paciente que se ha reservado en el espacio (no el tipo de servicio) |
coding | S | 1..1 | Coding | Códigos definidos por un sistema terminológico |
system | S | 1..1 | uri | Sistema terminológico, url/uri/uuid |
code | S | 1..1 | code | Código definido en un sistema terminológico |
display | S | 0..1 | string | Representación visual, definida por el sistema terminológico |
text | S | 0..1 | string | Representación textual del concepto |
start | S | 1..1 | instant | Inicio de esta cita |
end | S | 1..1 | instant | Término de esta cita |
created | S | 1..1 | dateTime | The date that this appointment was initially created |
Slices for participant | S | 2..2 | BackboneElement | Participante de esta cita médica Slice: Unordered, Open by value:actor.type |
participant:All Slices | Content/Rules for all slices | |||
actor | 0..1 | Reference(Patient LE | PractitionerRole LE) | Person, Location/HealthcareService or Device | |
participant:patientLE | S | 1..1 | BackboneElement | Participants involved in appointment |
actor | S | 1..1 | Reference(Patient LE) | Paciente participante de esta cita |
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Required Pattern: Patient | |
status | 1..1 | code | Estado de la cita, este puede ser "accepted | declined | tentative | needs-action" | |
participant:practitionerRoleLE | S | 1..1 | BackboneElement | Participants involved in appointment |
actor | S | 1..1 | Reference(PractitionerRole LE) | Persona y ubicación/servicio de atención médica participante de esta cita |
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Required Pattern: PractitionerRole | |
status | 1..1 | code | Estado, por defecto #accepted Required Pattern: accepted | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | C | 0..* | Appointment | 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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show |
id | SΣ | 1..1 | id | Id temporal necesario para identificar el recurso |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionMediodeContacto | S | 0..1 | CodeableConcept | Medio por donde se notificó al paciente URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/ExtensionMediodeContacto Binding: Medio Notificación (required) |
ExtensionContactadoLE | S | 1..1 | (Complex) | Extensión compleja, donde se indica si el paciente fue Contactado[true|false] o MotivoNoContactabilidad si la anterior fue false URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/Contactado |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..1 | Identifier | ID del identificador de la cita |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | Valor del Id Example General: 123456 |
status | ?!SΣ | 1..1 | code | Se considera el uso de SOLO estos estados: pending=pendiente | booked=cita agendada | cancelled=cita cancelada | noshow=no presentación Binding: AppointmentStatus (required): The free/busy status of an appointment. |
cancelationReason | SΣ | 0..1 | CodeableConcept | Uso en caso de cancelación de cita para registrar la razón Binding: AppointmentCancellationReason (example) |
coding | SΣ | 1..1 | Coding | Códigos definidos por un sistema terminológico |
system | SΣ | 1..1 | uri | Sistema terminológico, url/uri/uuid Required Pattern: http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason |
code | SΣ | 1..1 | code | Código definido en un sistema terminológico, para este caso se consideran los siguientes: pat(paciente) | prov(médico o institución) | other(otra razón) |
display | SΣ | 0..1 | string | Representación visual del concepto definido por el sistema terminológico |
appointmentType | SΣ | 0..1 | CodeableConcept | El estilo de cita médica o paciente que se ha reservado en el espacio (no el tipo de servicio) Binding: hl7VS-appointmentReasonCodes (preferred) |
coding | SΣ | 1..1 | Coding | Códigos definidos por un sistema terminológico |
system | SΣ | 1..1 | uri | Sistema terminológico, url/uri/uuid |
code | SΣ | 1..1 | code | Código definido en un sistema terminológico |
display | SΣ | 0..1 | string | Representación visual, definida por el sistema terminológico |
text | SΣ | 0..1 | string | Representación textual del concepto |
start | SΣ | 1..1 | instant | Inicio de esta cita |
end | SΣ | 1..1 | instant | Término de esta cita |
created | S | 1..1 | dateTime | The date that this appointment was initially created |
Slices for participant | SC | 2..2 | BackboneElement | Participante de esta cita médica Slice: Unordered, Open by value:actor.type app-1: Either the type or actor on the participant SHALL be specified |
participant:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | Σ | 0..1 | Reference(Patient LE | PractitionerRole LE) | Person, Location/HealthcareService or Device |
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
participant:patientLE | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | SΣ | 1..1 | Reference(Patient LE) | Paciente participante de esta cita |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient |
status | Σ | 1..1 | code | Estado de la cita, este puede ser "accepted | declined | tentative | needs-action" Binding: ParticipationStatus (required): The Participation status of an appointment. |
participant:practitionerRoleLE | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | SΣ | 1..1 | Reference(PractitionerRole LE) | Persona y ubicación/servicio de atención médica participante de esta cita |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: PractitionerRole |
status | Σ | 1..1 | code | Estado, por defecto #accepted Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard | |
Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard | |
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | |
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard | |
Appointment.participant:patientLE.actor.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Appointment.participant:patientLE.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard | |
Appointment.participant:practitionerRoleLE.actor.type | extensible | Pattern: PractitionerRolehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Appointment.participant:practitionerRoleLE.status | required | Pattern: acceptedhttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant, Appointment.participant:patientLE, Appointment.participant:practitionerRoleLE | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | 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 : 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() | |
dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Appointment | C | 0..* | Appointment | 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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show | ||||
id | SΣ | 1..1 | id | Id temporal necesario para identificar el recurso | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ExtensionMediodeContacto | S | 0..1 | CodeableConcept | Medio por donde se notificó al paciente URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/ExtensionMediodeContacto Binding: Medio Notificación (required) | ||||
ExtensionContactadoLE | S | 1..1 | (Complex) | Extensión compleja, donde se indica si el paciente fue Contactado[true|false] o MotivoNoContactabilidad si la anterior fue false URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/Contactado | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..1 | Identifier | ID del identificador de la cita | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | Valor del Id Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | Se considera el uso de SOLO estos estados: pending=pendiente | booked=cita agendada | cancelled=cita cancelada | noshow=no presentación Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
cancelationReason | SΣ | 0..1 | CodeableConcept | Uso en caso de cancelación de cita para registrar la razón Binding: AppointmentCancellationReason (example) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Códigos definidos por un sistema terminológico | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Sistema terminológico, url/uri/uuid Required Pattern: http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Código definido en un sistema terminológico, para este caso se consideran los siguientes: pat(paciente) | prov(médico o institución) | other(otra razón) | ||||
display | SΣ | 0..1 | string | Representación visual del concepto definido por el sistema terminológico | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
appointmentType | SΣ | 0..1 | CodeableConcept | El estilo de cita médica o paciente que se ha reservado en el espacio (no el tipo de servicio) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Códigos definidos por un sistema terminológico | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Sistema terminológico, url/uri/uuid | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Código definido en un sistema terminológico | ||||
display | SΣ | 0..1 | string | Representación visual, definida por el sistema terminológico | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | Representación textual del concepto | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment | |||||
start | SΣ | 1..1 | instant | Inicio de esta cita | ||||
end | SΣ | 1..1 | instant | Término de esta cita | ||||
minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
slot | 0..* | Reference(Slot) | The slots that this appointment is filling | |||||
created | S | 1..1 | dateTime | The date that this appointment was initially created | ||||
comment | 0..1 | string | Additional comments | |||||
patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |||||
basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
Slices for participant | SC | 2..2 | BackboneElement | Participante de esta cita médica Slice: Unordered, Open by value:actor.type app-1: Either the type or actor on the participant SHALL be specified | ||||
participant:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
actor | Σ | 0..1 | Reference(Patient LE | PractitionerRole LE) | Person, Location/HealthcareService or Device | ||||
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
period | 0..1 | Period | Participation period of the actor | |||||
participant:patientLE | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
actor | SΣ | 1..1 | Reference(Patient LE) | Paciente participante de esta cita | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
status | Σ | 1..1 | code | Estado de la cita, este puede ser "accepted | declined | tentative | needs-action" Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
period | 0..1 | Period | Participation period of the actor | |||||
participant:practitionerRoleLE | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
actor | SΣ | 1..1 | Reference(PractitionerRole LE) | Persona y ubicación/servicio de atención médica participante de esta cita | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: PractitionerRole | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
status | Σ | 1..1 | code | Estado, por defecto #accepted Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted | ||||
period | 0..1 | Period | Participation period of the actor | |||||
requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Appointment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Appointment.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard | ||||
Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard | ||||
Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Appointment.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | ||||
Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard | ||||
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard | ||||
Appointment.participant:patientLE.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Appointment.participant:patientLE.actor.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Appointment.participant:patientLE.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard | ||||
Appointment.participant:patientLE.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard | ||||
Appointment.participant:practitionerRoleLE.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Appointment.participant:practitionerRoleLE.actor.type | extensible | Pattern: PractitionerRolehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Appointment.participant:practitionerRoleLE.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard | ||||
Appointment.participant:practitionerRoleLE.status | required | Pattern: acceptedhttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant, Appointment.participant:patientLE, Appointment.participant:practitionerRoleLE | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | 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 : 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() | |
dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Appointment
Summary
Mandatory: 16 elements(6 nested mandatory elements)
Must-Support: 29 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from Appointment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | 0..* | Appointment | 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) | |
id | S | 1..1 | id | Id temporal necesario para identificar el recurso |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionMediodeContacto | S | 0..1 | CodeableConcept | Medio por donde se notificó al paciente URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/ExtensionMediodeContacto Binding: Medio Notificación (required) |
ExtensionContactadoLE | S | 1..1 | (Complex) | Extensión compleja, donde se indica si el paciente fue Contactado[true|false] o MotivoNoContactabilidad si la anterior fue false URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/Contactado |
identifier | S | 1..1 | Identifier | ID del identificador de la cita |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | Valor del Id |
status | S | 1..1 | code | Se considera el uso de SOLO estos estados: pending=pendiente | booked=cita agendada | cancelled=cita cancelada | noshow=no presentación |
cancelationReason | S | 0..1 | CodeableConcept | Uso en caso de cancelación de cita para registrar la razón |
coding | S | 1..1 | Coding | Códigos definidos por un sistema terminológico |
system | S | 1..1 | uri | Sistema terminológico, url/uri/uuid Required Pattern: http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason |
code | S | 1..1 | code | Código definido en un sistema terminológico, para este caso se consideran los siguientes: pat(paciente) | prov(médico o institución) | other(otra razón) |
display | S | 0..1 | string | Representación visual del concepto definido por el sistema terminológico |
appointmentType | S | 0..1 | CodeableConcept | El estilo de cita médica o paciente que se ha reservado en el espacio (no el tipo de servicio) |
coding | S | 1..1 | Coding | Códigos definidos por un sistema terminológico |
system | S | 1..1 | uri | Sistema terminológico, url/uri/uuid |
code | S | 1..1 | code | Código definido en un sistema terminológico |
display | S | 0..1 | string | Representación visual, definida por el sistema terminológico |
text | S | 0..1 | string | Representación textual del concepto |
start | S | 1..1 | instant | Inicio de esta cita |
end | S | 1..1 | instant | Término de esta cita |
created | S | 1..1 | dateTime | The date that this appointment was initially created |
Slices for participant | S | 2..2 | BackboneElement | Participante de esta cita médica Slice: Unordered, Open by value:actor.type |
participant:All Slices | Content/Rules for all slices | |||
actor | 0..1 | Reference(Patient LE | PractitionerRole LE) | Person, Location/HealthcareService or Device | |
participant:patientLE | S | 1..1 | BackboneElement | Participants involved in appointment |
actor | S | 1..1 | Reference(Patient LE) | Paciente participante de esta cita |
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Required Pattern: Patient | |
status | 1..1 | code | Estado de la cita, este puede ser "accepted | declined | tentative | needs-action" | |
participant:practitionerRoleLE | S | 1..1 | BackboneElement | Participants involved in appointment |
actor | S | 1..1 | Reference(PractitionerRole LE) | Persona y ubicación/servicio de atención médica participante de esta cita |
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Required Pattern: PractitionerRole | |
status | 1..1 | code | Estado, por defecto #accepted Required Pattern: accepted | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | C | 0..* | Appointment | 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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show |
id | SΣ | 1..1 | id | Id temporal necesario para identificar el recurso |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionMediodeContacto | S | 0..1 | CodeableConcept | Medio por donde se notificó al paciente URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/ExtensionMediodeContacto Binding: Medio Notificación (required) |
ExtensionContactadoLE | S | 1..1 | (Complex) | Extensión compleja, donde se indica si el paciente fue Contactado[true|false] o MotivoNoContactabilidad si la anterior fue false URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/Contactado |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..1 | Identifier | ID del identificador de la cita |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | Valor del Id Example General: 123456 |
status | ?!SΣ | 1..1 | code | Se considera el uso de SOLO estos estados: pending=pendiente | booked=cita agendada | cancelled=cita cancelada | noshow=no presentación Binding: AppointmentStatus (required): The free/busy status of an appointment. |
cancelationReason | SΣ | 0..1 | CodeableConcept | Uso en caso de cancelación de cita para registrar la razón Binding: AppointmentCancellationReason (example) |
coding | SΣ | 1..1 | Coding | Códigos definidos por un sistema terminológico |
system | SΣ | 1..1 | uri | Sistema terminológico, url/uri/uuid Required Pattern: http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason |
code | SΣ | 1..1 | code | Código definido en un sistema terminológico, para este caso se consideran los siguientes: pat(paciente) | prov(médico o institución) | other(otra razón) |
display | SΣ | 0..1 | string | Representación visual del concepto definido por el sistema terminológico |
appointmentType | SΣ | 0..1 | CodeableConcept | El estilo de cita médica o paciente que se ha reservado en el espacio (no el tipo de servicio) Binding: hl7VS-appointmentReasonCodes (preferred) |
coding | SΣ | 1..1 | Coding | Códigos definidos por un sistema terminológico |
system | SΣ | 1..1 | uri | Sistema terminológico, url/uri/uuid |
code | SΣ | 1..1 | code | Código definido en un sistema terminológico |
display | SΣ | 0..1 | string | Representación visual, definida por el sistema terminológico |
text | SΣ | 0..1 | string | Representación textual del concepto |
start | SΣ | 1..1 | instant | Inicio de esta cita |
end | SΣ | 1..1 | instant | Término de esta cita |
created | S | 1..1 | dateTime | The date that this appointment was initially created |
Slices for participant | SC | 2..2 | BackboneElement | Participante de esta cita médica Slice: Unordered, Open by value:actor.type app-1: Either the type or actor on the participant SHALL be specified |
participant:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | Σ | 0..1 | Reference(Patient LE | PractitionerRole LE) | Person, Location/HealthcareService or Device |
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
participant:patientLE | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | SΣ | 1..1 | Reference(Patient LE) | Paciente participante de esta cita |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient |
status | Σ | 1..1 | code | Estado de la cita, este puede ser "accepted | declined | tentative | needs-action" Binding: ParticipationStatus (required): The Participation status of an appointment. |
participant:practitionerRoleLE | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | SΣ | 1..1 | Reference(PractitionerRole LE) | Persona y ubicación/servicio de atención médica participante de esta cita |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: PractitionerRole |
status | Σ | 1..1 | code | Estado, por defecto #accepted Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard | |
Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard | |
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | |
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard | |
Appointment.participant:patientLE.actor.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Appointment.participant:patientLE.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard | |
Appointment.participant:practitionerRoleLE.actor.type | extensible | Pattern: PractitionerRolehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Appointment.participant:practitionerRoleLE.status | required | Pattern: acceptedhttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant, Appointment.participant:patientLE, Appointment.participant:practitionerRoleLE | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | 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 : 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() | |
dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Appointment | C | 0..* | Appointment | 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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show | ||||
id | SΣ | 1..1 | id | Id temporal necesario para identificar el recurso | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ExtensionMediodeContacto | S | 0..1 | CodeableConcept | Medio por donde se notificó al paciente URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/ExtensionMediodeContacto Binding: Medio Notificación (required) | ||||
ExtensionContactadoLE | S | 1..1 | (Complex) | Extensión compleja, donde se indica si el paciente fue Contactado[true|false] o MotivoNoContactabilidad si la anterior fue false URL: https://interoperabilidad.minsal.cl/fhir/ig/tei/StructureDefinition/Contactado | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..1 | Identifier | ID del identificador de la cita | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | Valor del Id Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | Se considera el uso de SOLO estos estados: pending=pendiente | booked=cita agendada | cancelled=cita cancelada | noshow=no presentación Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
cancelationReason | SΣ | 0..1 | CodeableConcept | Uso en caso de cancelación de cita para registrar la razón Binding: AppointmentCancellationReason (example) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Códigos definidos por un sistema terminológico | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Sistema terminológico, url/uri/uuid Required Pattern: http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Código definido en un sistema terminológico, para este caso se consideran los siguientes: pat(paciente) | prov(médico o institución) | other(otra razón) | ||||
display | SΣ | 0..1 | string | Representación visual del concepto definido por el sistema terminológico | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
appointmentType | SΣ | 0..1 | CodeableConcept | El estilo de cita médica o paciente que se ha reservado en el espacio (no el tipo de servicio) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Códigos definidos por un sistema terminológico | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Sistema terminológico, url/uri/uuid | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Código definido en un sistema terminológico | ||||
display | SΣ | 0..1 | string | Representación visual, definida por el sistema terminológico | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | Representación textual del concepto | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment | |||||
start | SΣ | 1..1 | instant | Inicio de esta cita | ||||
end | SΣ | 1..1 | instant | Término de esta cita | ||||
minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
slot | 0..* | Reference(Slot) | The slots that this appointment is filling | |||||
created | S | 1..1 | dateTime | The date that this appointment was initially created | ||||
comment | 0..1 | string | Additional comments | |||||
patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |||||
basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
Slices for participant | SC | 2..2 | BackboneElement | Participante de esta cita médica Slice: Unordered, Open by value:actor.type app-1: Either the type or actor on the participant SHALL be specified | ||||
participant:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
actor | Σ | 0..1 | Reference(Patient LE | PractitionerRole LE) | Person, Location/HealthcareService or Device | ||||
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
period | 0..1 | Period | Participation period of the actor | |||||
participant:patientLE | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
actor | SΣ | 1..1 | Reference(Patient LE) | Paciente participante de esta cita | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
status | Σ | 1..1 | code | Estado de la cita, este puede ser "accepted | declined | tentative | needs-action" Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
period | 0..1 | Period | Participation period of the actor | |||||
participant:practitionerRoleLE | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
actor | SΣ | 1..1 | Reference(PractitionerRole LE) | Persona y ubicación/servicio de atención médica participante de esta cita | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 1..1 | uri | Tipo de participante de la cita al que se hace referencia Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: PractitionerRole | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
status | Σ | 1..1 | code | Estado, por defecto #accepted Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted | ||||
period | 0..1 | Period | Participation period of the actor | |||||
requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Appointment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Appointment.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard | ||||
Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard | ||||
Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Appointment.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | ||||
Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard | ||||
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard | ||||
Appointment.participant:patientLE.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Appointment.participant:patientLE.actor.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Appointment.participant:patientLE.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard | ||||
Appointment.participant:patientLE.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard | ||||
Appointment.participant:practitionerRoleLE.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Appointment.participant:practitionerRoleLE.actor.type | extensible | Pattern: PractitionerRolehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Appointment.participant:practitionerRoleLE.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard | ||||
Appointment.participant:practitionerRoleLE.status | required | Pattern: acceptedhttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant, Appointment.participant:patientLE, Appointment.participant:practitionerRoleLE | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | 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 : 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() | |
dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Appointment
Summary
Mandatory: 16 elements(6 nested mandatory elements)
Must-Support: 29 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron