Guía de Implementación Hackathon HLF 2023
1.0.1 - release
Guía de Implementación Hackathon HLF 2023
1.0.1 - release
Guía de Implementación Hackathon HLF 2023 - Local Development build (v1.0.1). See the Directory of published versions
| Official URL: https://hlf.cl/fhir/ig/hackaton/StructureDefinition/CitasHackaton | Version: 1.0.1 | |||
| Active as of 2023-07-24 | Computable Name: CitasHackaton | |||
Perfil para una cita de agenda de paciente
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) | |
  status | S | 1..1 | code | Estado de la Cita: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): Códigos definidos por estándar |
 serviceCategory | S | 1..1 | CodeableConcept | Define el tipo de atención Binding: Códigos para tipos de atención (required): Códigos definidos localmente |
 coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 0..1 | uri | Sistema de Codificación Ocupado | |
| code | 0..1 | code | Código Servicio de Atención | |
 display | 1..1 | string | Glosa asociada al código | |
| text | 0..1 | string | Texto libre que describe el servicio | |
| specialty | S | 1..1 | CodeableConcept | Define la especialidad de la atención Binding: Códigos para especialidades médicas (required): Códigos definidos localmente |
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 0..1 | uri | Sistema de Codificación Ocupado | |
| code | 0..1 | code | Código de especialidad | |
| display | 1..1 | string | Glosa asociada al código | |
| text | 0..1 | string | texto libre que describe la especialidad | |
| start | S | 1..1 | instant | Cuando se realizará/realizó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| end | S | 1..1 | instant | Cuando se terminará/terminó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| subject | S | 1..1 | Reference(Patient | Group) | Paciente a ser atendido |
| reference | 0..1 | string | uri del recurso del paciente a ser atendido | |
 participant | S | 1..* | BackboneElement | Participante del encuentro, se define en principio el Prestador |
 actor | 1..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | referencia al recurso del participante | |
| reference | 1..1 | string | uri del recurso del del actor aludido | |
| status | S | 1..1 | code | Estado de aceptación de la cita: accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): Códigos definidos por estándar Required Pattern: accepted |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Appointment.status | required | AppointmentStatus |
| Appointment.serviceCategory | required | TipoAtencionVS (a valid code from Códigos para Tipo de Atención) |
| Appointment.specialty | required | EspecialidadMedicaVS (a valid code from Códigos para Especialidades Médicas) |
| Appointment.participant.status | required | Pattern: accepted |
| 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) |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣC | 1..1 | code | Estado de la Cita: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): Códigos definidos por estándar |
 serviceCategory | SΣ | 1..1 | CodeableConcept | Define el tipo de atención Binding: Códigos para tipos de atención (required): Códigos definidos localmente |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 0..1 | uri | Sistema de Codificación Ocupado |
| code | ΣC | 0..1 | code | Código Servicio de Atención |
| display | ΣC | 1..1 | string | Glosa asociada al código |
| text | Σ | 0..1 | string | Texto libre que describe el servicio |
| specialty | SΣ | 1..1 | CodeableConcept | Define la especialidad de la atención Binding: Códigos para especialidades médicas (required): Códigos definidos localmente |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 0..1 | uri | Sistema de Codificación Ocupado |
| code | ΣC | 0..1 | code | Código de especialidad |
| display | ΣC | 1..1 | string | Glosa asociada al código |
| text | Σ | 0..1 | string | texto libre que describe la especialidad |
| start | SΣC | 1..1 | instant | Cuando se realizará/realizó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| end | SΣC | 1..1 | instant | Cuando se terminará/terminó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
 subject | SΣ | 1..1 | Reference(Patient | Group) | Paciente a ser atendido |
| reference | ΣC | 0..1 | string | uri del recurso del paciente a ser atendido |
| participant | SC | 1..* | BackboneElement | Participante del encuentro, se define en principio el Prestador |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | ΣC | 1..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | referencia al recurso del participante |
| reference | ΣC | 1..1 | string | uri del recurso del del actor aludido |
| status | SΣ | 1..1 | code | Estado de aceptación de la cita: accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): Códigos definidos por estándar Required Pattern: accepted |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Appointment.status | required | AppointmentStatus |
| Appointment.serviceCategory | required | TipoAtencionVS (a valid code from Códigos para Tipo de Atención) |
| Appointment.specialty | required | EspecialidadMedicaVS (a valid code from Códigos para Especialidades Médicas) |
| Appointment.participant.status | required | Pattern: accepted |
| Id | Grade | Path(s) | Details | Requirements |
| app-1 | error | Appointment.participant | 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 | Cancellation reason is only used for appointments that have been cancelled, or noshow : cancellationReason.exists() implies (status='noshow' or status='cancelled') | |
| app-5 | error | Appointment | The start must be less than or equal to the end : start.exists() implies start <= end | |
| app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both : originatingAppointment.exists().not() or recurrenceTemplate.exists().not() | |
| app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow : cancellationDate.exists() implies (status='noshow' or 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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) |
| id | Σ | 0..1 | id | Logical id of this artifact |
| 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: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Ids for this item |
| status | ?!SΣC | 1..1 | code | Estado de la Cita: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): Códigos definidos por estándar |
| cancellationReason | ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) |
| class | Σ | 0..* | CodeableConcept | Classification when becoming an encounter Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter. |
| serviceCategory | SΣ | 1..1 | CodeableConcept | Define el tipo de atención Binding: Códigos para tipos de atención (required): Códigos definidos localmente |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Sistema de Codificación Ocupado |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Código Servicio de Atención |
| display | ΣC | 1..1 | string | Glosa asociada al código |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Texto libre que describe el servicio |
| serviceType | Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
| specialty | SΣ | 1..1 | CodeableConcept | Define la especialidad de la atención Binding: Códigos para especialidades médicas (required): Códigos definidos localmente |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Sistema de Codificación Ocupado |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Código de especialidad |
| display | ΣC | 1..1 | string | Glosa asociada al código |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | texto libre que describe la especialidad |
| appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) |
| reason | Σ | 0..* | CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. |
| priority | 0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment. | |
| description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |
| replaces | 0..* | Reference(Appointment) | Appointment replaced by this Appointment | |
| virtualService | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |
| supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment | |
| previousAppointment | 0..1 | Reference(Appointment) | The previous appointment in a series | |
| originatingAppointment | C | 0..1 | Reference(Appointment) | The originating appointment in a recurring set of appointments |
| start | SΣC | 1..1 | instant | Cuando se realizará/realizó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| end | SΣC | 1..1 | instant | Cuando se terminará/terminó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |
| slot | 0..* | Reference(Slot) | The slots that this appointment is filling | |
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | |
| created | 0..1 | dateTime | The date that this appointment was initially created | |
| cancellationDate | C | 0..1 | dateTime | When the appointment was cancelled |
| note | 0..* | Annotation | Additional comments | |
| patientInstruction | 0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | |
| basedOn | 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request this appointment is allocated to assess | |
| subject | SΣ | 1..1 | Reference(Patient | Group) | Paciente a ser atendido |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣC | 0..1 | string | uri del recurso del paciente a ser atendido |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣC | 0..1 | string | Text alternative for the resource |
| participant | SC | 1..* | BackboneElement | Participante del encuentro, se define en principio el Prestador |
| 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 | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| period | 0..1 | Period | Participation period of the actor | |
| actor | ΣC | 1..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | referencia al recurso del participante |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣC | 1..1 | string | uri del recurso del del actor aludido |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣC | 0..1 | string | Text alternative for the resource |
| required | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
| status | SΣ | 1..1 | code | Estado de aceptación de la cita: accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): Códigos definidos por estándar Required Pattern: accepted |
| recurrenceId | 0..1 | positiveInt | The sequence number in the recurrence | |
| occurrenceChanged | 0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |
| recurrenceTemplate | C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences |
| 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 |
| timezone | 0..1 | CodeableConcept | The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175) | |
| recurrenceType | 1..1 | CodeableConcept | The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175) | |
| lastOccurrenceDate | 0..1 | date | The date when the recurrence should end | |
| occurrenceCount | 0..1 | positiveInt | The number of planned occurrences | |
| occurrenceDate | 0..* | date | Specific dates for a recurring set of appointments (no template) | |
| weeklyTemplate | 0..1 | BackboneElement | Information about weekly recurring appointments | |
| 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 |
| monday | 0..1 | boolean | Recurs on Mondays | |
| tuesday | 0..1 | boolean | Recurs on Tuesday | |
| wednesday | 0..1 | boolean | Recurs on Wednesday | |
| thursday | 0..1 | boolean | Recurs on Thursday | |
| friday | 0..1 | boolean | Recurs on Friday | |
| saturday | 0..1 | boolean | Recurs on Saturday | |
| sunday | 0..1 | boolean | Recurs on Sunday | |
| weekInterval | 0..1 | positiveInt | Recurs every nth week | |
| monthlyTemplate | 0..1 | BackboneElement | Information about monthly recurring appointments | |
| 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 |
| dayOfMonth | 0..1 | positiveInt | Recurs on a specific day of the month | |
| nthWeekOfMonth | 0..1 | Coding | Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month. | |
| dayOfWeek | 0..1 | Coding | Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week. | |
| monthInterval | 1..1 | positiveInt | Recurs every nth month | |
| yearlyTemplate | 0..1 | BackboneElement | Information about yearly recurring appointments | |
| 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 |
| yearInterval | 1..1 | positiveInt | Recurs every nth year | |
| excludingDate | 0..* | date | Any dates that should be excluded from the series | |
| excludingRecurrenceId | 0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Appointment.language | required | AllLanguages |
| Appointment.status | required | AppointmentStatus |
| Appointment.cancellationReason | example | AppointmentCancellationReason |
| Appointment.class | preferred | http://terminology.hl7.org/ValueSet/EncounterClass |
| Appointment.serviceCategory | required | TipoAtencionVS (a valid code from Códigos para Tipo de Atención) |
| Appointment.serviceType | example | ServiceType |
| Appointment.specialty | required | EspecialidadMedicaVS (a valid code from Códigos para Especialidades Médicas) |
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes |
| Appointment.reason | preferred | EncounterReasonCodes |
| Appointment.priority | example | ActPriority |
| Appointment.subject.type | extensible | ResourceType |
| Appointment.participant.type | extensible | ParticipantType |
| Appointment.participant.actor.type | extensible | ResourceType |
| Appointment.participant.status | required | Pattern: accepted |
| Appointment.recurrenceTemplate.timezone | required | IANATimezones (a valid code from https://www.iana.org/time-zones) |
| Appointment.recurrenceTemplate.recurrenceType | preferred | AppointmentRecurrenceType |
| Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth | required | WeekOfMonth |
| Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek | required | DaysOfWeek |
| Id | Grade | Path(s) | Details | Requirements |
| app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.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
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) | |
| status | S | 1..1 | code | Estado de la Cita: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): Códigos definidos por estándar |
| serviceCategory | S | 1..1 | CodeableConcept | Define el tipo de atención Binding: Códigos para tipos de atención (required): Códigos definidos localmente |
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 0..1 | uri | Sistema de Codificación Ocupado | |
| code | 0..1 | code | Código Servicio de Atención | |
| display | 1..1 | string | Glosa asociada al código | |
| text | 0..1 | string | Texto libre que describe el servicio | |
| specialty | S | 1..1 | CodeableConcept | Define la especialidad de la atención Binding: Códigos para especialidades médicas (required): Códigos definidos localmente |
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 0..1 | uri | Sistema de Codificación Ocupado | |
| code | 0..1 | code | Código de especialidad | |
| display | 1..1 | string | Glosa asociada al código | |
| text | 0..1 | string | texto libre que describe la especialidad | |
| start | S | 1..1 | instant | Cuando se realizará/realizó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| end | S | 1..1 | instant | Cuando se terminará/terminó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| subject | S | 1..1 | Reference(Patient | Group) | Paciente a ser atendido |
| reference | 0..1 | string | uri del recurso del paciente a ser atendido | |
| participant | S | 1..* | BackboneElement | Participante del encuentro, se define en principio el Prestador |
| actor | 1..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | referencia al recurso del participante | |
| reference | 1..1 | string | uri del recurso del del actor aludido | |
| status | S | 1..1 | code | Estado de aceptación de la cita: accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): Códigos definidos por estándar Required Pattern: accepted |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Appointment.status | required | AppointmentStatus |
| Appointment.serviceCategory | required | TipoAtencionVS (a valid code from Códigos para Tipo de Atención) |
| Appointment.specialty | required | EspecialidadMedicaVS (a valid code from Códigos para Especialidades Médicas) |
| Appointment.participant.status | required | Pattern: accepted |
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) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣC | 1..1 | code | Estado de la Cita: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): Códigos definidos por estándar |
| serviceCategory | SΣ | 1..1 | CodeableConcept | Define el tipo de atención Binding: Códigos para tipos de atención (required): Códigos definidos localmente |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 0..1 | uri | Sistema de Codificación Ocupado |
| code | ΣC | 0..1 | code | Código Servicio de Atención |
| display | ΣC | 1..1 | string | Glosa asociada al código |
| text | Σ | 0..1 | string | Texto libre que describe el servicio |
| specialty | SΣ | 1..1 | CodeableConcept | Define la especialidad de la atención Binding: Códigos para especialidades médicas (required): Códigos definidos localmente |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 0..1 | uri | Sistema de Codificación Ocupado |
| code | ΣC | 0..1 | code | Código de especialidad |
| display | ΣC | 1..1 | string | Glosa asociada al código |
| text | Σ | 0..1 | string | texto libre que describe la especialidad |
| start | SΣC | 1..1 | instant | Cuando se realizará/realizó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| end | SΣC | 1..1 | instant | Cuando se terminará/terminó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| subject | SΣ | 1..1 | Reference(Patient | Group) | Paciente a ser atendido |
| reference | ΣC | 0..1 | string | uri del recurso del paciente a ser atendido |
| participant | SC | 1..* | BackboneElement | Participante del encuentro, se define en principio el Prestador |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | ΣC | 1..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | referencia al recurso del participante |
| reference | ΣC | 1..1 | string | uri del recurso del del actor aludido |
| status | SΣ | 1..1 | code | Estado de aceptación de la cita: accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): Códigos definidos por estándar Required Pattern: accepted |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Appointment.status | required | AppointmentStatus |
| Appointment.serviceCategory | required | TipoAtencionVS (a valid code from Códigos para Tipo de Atención) |
| Appointment.specialty | required | EspecialidadMedicaVS (a valid code from Códigos para Especialidades Médicas) |
| Appointment.participant.status | required | Pattern: accepted |
| Id | Grade | Path(s) | Details | Requirements |
| app-1 | error | Appointment.participant | 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 | Cancellation reason is only used for appointments that have been cancelled, or noshow : cancellationReason.exists() implies (status='noshow' or status='cancelled') | |
| app-5 | error | Appointment | The start must be less than or equal to the end : start.exists() implies start <= end | |
| app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both : originatingAppointment.exists().not() or recurrenceTemplate.exists().not() | |
| app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow : cancellationDate.exists() implies (status='noshow' or 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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) |
| id | Σ | 0..1 | id | Logical id of this artifact |
| 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: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Ids for this item |
| status | ?!SΣC | 1..1 | code | Estado de la Cita: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): Códigos definidos por estándar |
| cancellationReason | ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) |
| class | Σ | 0..* | CodeableConcept | Classification when becoming an encounter Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter. |
| serviceCategory | SΣ | 1..1 | CodeableConcept | Define el tipo de atención Binding: Códigos para tipos de atención (required): Códigos definidos localmente |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Sistema de Codificación Ocupado |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Código Servicio de Atención |
| display | ΣC | 1..1 | string | Glosa asociada al código |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Texto libre que describe el servicio |
| serviceType | Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
| specialty | SΣ | 1..1 | CodeableConcept | Define la especialidad de la atención Binding: Códigos para especialidades médicas (required): Códigos definidos localmente |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Sistema de Codificación Ocupado |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 0..1 | code | Código de especialidad |
| display | ΣC | 1..1 | string | Glosa asociada al código |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | texto libre que describe la especialidad |
| appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) |
| reason | Σ | 0..* | CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. |
| priority | 0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment. | |
| description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |
| replaces | 0..* | Reference(Appointment) | Appointment replaced by this Appointment | |
| virtualService | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |
| supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment | |
| previousAppointment | 0..1 | Reference(Appointment) | The previous appointment in a series | |
| originatingAppointment | C | 0..1 | Reference(Appointment) | The originating appointment in a recurring set of appointments |
| start | SΣC | 1..1 | instant | Cuando se realizará/realizó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| end | SΣC | 1..1 | instant | Cuando se terminará/terminó la cita en formato YYYY-MM-DDThh:mm:ss.sss+zz:zz |
| minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |
| slot | 0..* | Reference(Slot) | The slots that this appointment is filling | |
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | |
| created | 0..1 | dateTime | The date that this appointment was initially created | |
| cancellationDate | C | 0..1 | dateTime | When the appointment was cancelled |
| note | 0..* | Annotation | Additional comments | |
| patientInstruction | 0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | |
| basedOn | 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request this appointment is allocated to assess | |
| subject | SΣ | 1..1 | Reference(Patient | Group) | Paciente a ser atendido |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣC | 0..1 | string | uri del recurso del paciente a ser atendido |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣC | 0..1 | string | Text alternative for the resource |
| participant | SC | 1..* | BackboneElement | Participante del encuentro, se define en principio el Prestador |
| 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 | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| period | 0..1 | Period | Participation period of the actor | |
| actor | ΣC | 1..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | referencia al recurso del participante |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣC | 1..1 | string | uri del recurso del del actor aludido |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣC | 0..1 | string | Text alternative for the resource |
| required | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
| status | SΣ | 1..1 | code | Estado de aceptación de la cita: accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): Códigos definidos por estándar Required Pattern: accepted |
| recurrenceId | 0..1 | positiveInt | The sequence number in the recurrence | |
| occurrenceChanged | 0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |
| recurrenceTemplate | C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences |
| 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 |
| timezone | 0..1 | CodeableConcept | The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175) | |
| recurrenceType | 1..1 | CodeableConcept | The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175) | |
| lastOccurrenceDate | 0..1 | date | The date when the recurrence should end | |
| occurrenceCount | 0..1 | positiveInt | The number of planned occurrences | |
| occurrenceDate | 0..* | date | Specific dates for a recurring set of appointments (no template) | |
| weeklyTemplate | 0..1 | BackboneElement | Information about weekly recurring appointments | |
| 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 |
| monday | 0..1 | boolean | Recurs on Mondays | |
| tuesday | 0..1 | boolean | Recurs on Tuesday | |
| wednesday | 0..1 | boolean | Recurs on Wednesday | |
| thursday | 0..1 | boolean | Recurs on Thursday | |
| friday | 0..1 | boolean | Recurs on Friday | |
| saturday | 0..1 | boolean | Recurs on Saturday | |
| sunday | 0..1 | boolean | Recurs on Sunday | |
| weekInterval | 0..1 | positiveInt | Recurs every nth week | |
| monthlyTemplate | 0..1 | BackboneElement | Information about monthly recurring appointments | |
| 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 |
| dayOfMonth | 0..1 | positiveInt | Recurs on a specific day of the month | |
| nthWeekOfMonth | 0..1 | Coding | Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month. | |
| dayOfWeek | 0..1 | Coding | Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week. | |
| monthInterval | 1..1 | positiveInt | Recurs every nth month | |
| yearlyTemplate | 0..1 | BackboneElement | Information about yearly recurring appointments | |
| 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 |
| yearInterval | 1..1 | positiveInt | Recurs every nth year | |
| excludingDate | 0..* | date | Any dates that should be excluded from the series | |
| excludingRecurrenceId | 0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Appointment.language | required | AllLanguages |
| Appointment.status | required | AppointmentStatus |
| Appointment.cancellationReason | example | AppointmentCancellationReason |
| Appointment.class | preferred | http://terminology.hl7.org/ValueSet/EncounterClass |
| Appointment.serviceCategory | required | TipoAtencionVS (a valid code from Códigos para Tipo de Atención) |
| Appointment.serviceType | example | ServiceType |
| Appointment.specialty | required | EspecialidadMedicaVS (a valid code from Códigos para Especialidades Médicas) |
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes |
| Appointment.reason | preferred | EncounterReasonCodes |
| Appointment.priority | example | ActPriority |
| Appointment.subject.type | extensible | ResourceType |
| Appointment.participant.type | extensible | ParticipantType |
| Appointment.participant.actor.type | extensible | ResourceType |
| Appointment.participant.status | required | Pattern: accepted |
| Appointment.recurrenceTemplate.timezone | required | IANATimezones (a valid code from https://www.iana.org/time-zones) |
| Appointment.recurrenceTemplate.recurrenceType | preferred | AppointmentRecurrenceType |
| Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth | required | WeekOfMonth |
| Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek | required | DaysOfWeek |
| Id | Grade | Path(s) | Details | Requirements |
| app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.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
Other representations of profile: CSV, Excel, Schematron
Se describe abajo un resumen de las operaciones de búsqueda sobre este perfil. Se despliegan solo aquellas requeridas para este caso de uso y el formato de la expresión
| date | date | Búsqueda por fecha y hora específica | GET [URL_Base]/Appointment?date=2018-05-07T16:00:00-03:00 |
|---|---|---|---|
| date | date | Citas desde una fecha en adelante | GET [URL_Base]/Appointment?date=ge2018-05-07T16:00:00-03:00 |
| date | date | Citas desde una fecha hacia atrás | GET [URL_Base]/Appointment?date=le2018-05-07T16:00:00-03:00 |