ÚNICAS Rare Diseases HL7 FHIR Implementation Guide
0.0.1 - draft

ÚNICAS Rare Diseases HL7 FHIR Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Appointment Cita Agenda ÚNICAS

Official URL: https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASAppointment Version: 0.0.1
Draft as of 2025-08-12 Computable Name: UNICASAppointment

Este perfil define las restricciones del recurso Appointment para representar el registro de una cita programada en el contexto del caso de uso de ÚNICAS.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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)
Constraints: app-2, app-3, app-4, app-5, app-6, app-7
... 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
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system ΣC 1..1 uri Sistema para identificar el origen
Constraints: regcess-system
Example General: urn:regcess:0123456789
.... value ΣC 1..1 string Identificador interno del sistema para la cita programada
Example General: 123456
... status ?!ΣC 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... serviceCategory Σ 0..* CodeableConcept Categorización de la cita
Binding: Value set de Tipos de servicios asistenciales para ÚNICAS (preferred): Value set de Tipos de servicios asistenciales para ÚNICAS
... serviceType Σ 0..* CodeableReference(HealthcareService) Canal de cita
Binding: Value set de Canales de cita (preferred): Value set de Canales de cita
.... concept Σ 0..1 CodeableConcept Canal de cita
... reason Σ 1..* CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) Motivo de cita
Binding: Value set de Motivos de la cita (preferred): Value set de Motivos de la cita
.... concept Σ 0..1 CodeableConcept Motivo de cita
... start ΣC 1..1 instant Fecha y hora de inicio de la cita programada
... end ΣC 0..1 instant Fecha y hora de fin de la cita programada
... minutesDuration 0..1 positiveInt Duración de la cita programada
... created 0..1 dateTime Fecha y hora de creación de la cita
... cancellationDate C 0..1 dateTime Fecha y hora de cancelación de la cita
... note 0..* Annotation Comentario
.... text Σ 1..1 markdown Comentario
... subject Σ 1..1 Reference(Patient Paciente ÚNICAS) Referencia al paciente
.... reference ΣC 0..1 string Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
.... type Σ 1..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 1..1 Identifier Identificador de paciente CIP-SNS. Cuando no tengamos recurso Patient, se debera informar el identificador de paciente mediante CIP-SNS
..... use ?!Σ 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 Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
..... system Σ 0..1 uri OID registro de número de CIP-SNS
Example General: urn:oid:2.16.724.4.40
..... value ΣC 0..1 string Número CIP-SNS
Example General: BBBBBBBBQR648597
.... display ΣC 0..1 string Nombre completo del paciente
... Slices for participant C 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by profile:resource
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:ProfesionalSanitarioParticipante C 1..* BackboneElement Profesional sanitario participante
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor ΣC 0..1 Reference(PractitionerRole Profesional Sanitario ÚNICAS | Practitioner Profesional Sanitario ÚNICAS) Referencia al profesional sanitario
...... reference ΣC 0..1 string Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
...... type Σ 1..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier ΣC 1..1 Identifier Identificadores del profesional sanitario. Cuando no tengamos recurso Practitioner, se debera informar el identificador del profesional sanitario mediante DNI como dato mínimo. Adicionalmente, se puede informar el número colegiado del profesional sanitario como dato recomendado
....... Slices for extension Content/Rules for all slices
........ extension:numeroColegiadoProfesionalSanitario 0..* Identifier Número de colegiado del profesional sanitario
URL: https://unicas-fhir.sanidad.gob.es/StructureDefinition/NumeroColegiadoProfesionalSanitario
....... use ?!Σ 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 Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
....... system Σ 0..1 uri OID registro de DNI
Example General: urn:oid:1.3.6.1.4.1.19126.3
....... value ΣC 0..1 string Número del DNI
Example General: 0000001X
...... display ΣC 0..1 string Nombre completo del profesional sanitario
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:ServicioAsistencialParticipante C 1..* BackboneElement Servicio asistencial (Localización) participante
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor ΣC 0..1 Reference(Location Localización y Servicio Asistencial ÚNICAS) Referencia a la localización y servicio asistencial
...... reference ΣC 0..1 string Referencia recurso FHIR
...... type Σ 0..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier ΣC 0..1 Identifier Identificador del recurso FHIR
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 0..1 uri Sistema para identificar el origen
Example General: urn:regcess:0123456789
....... value ΣC 0..1 string Identificador interno del sistema para la localización
Example General: 123456
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0
From the FHIR Standard
Appointment.serviceCategorypreferredValuesetTiposServiciosAsistenciales
https://unicas-fhir.sanidad.gob.es/ValueSet/TiposServicios
From this IG
Appointment.serviceTypepreferredValuesetCanalesCita
https://unicas-fhir.sanidad.gob.es/ValueSet/CanalesCita
From this IG
Appointment.reasonpreferredValuesetMotivosCita
https://unicas-fhir.sanidad.gob.es/ValueSet/MotivosCita
From this IG
Appointment.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.subject.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.subject.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participant, Appointment.participant:ProfesionalSanitarioParticipante, Appointment.participant:ServicioAsistencialParticipanteEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancellation reason is only used for appointments that have been cancelled, or noshow
: cancellationReason.exists() implies (status='noshow' or status='cancelled')
app-5errorAppointmentThe start must be less than or equal to the end
: start.exists() implies start <= end
app-6best practiceAppointmentAn appointment may have an originatingAppointment or recurrenceTemplate, but not both
: originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
app-7errorAppointmentCancellation date is only used for appointments that have been cancelled, or noshow
: cancellationDate.exists() implies (status='noshow' or status='cancelled')
dom-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
regcess-systemwarningAppointment.identifier.systemsystem debe comenzar por urn:regcess: seguido del identificador del sistema.
: matches('^urn:regcess:[A-Za-z0-9]+$')

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment Appointment
... identifier 1..* Identifier Identificador único
.... system C 1..1 uri Sistema para identificar el origen
Constraints: regcess-system
.... value 1..1 string Identificador interno del sistema para la cita programada
... serviceCategory 0..* CodeableConcept Categorización de la cita
Binding: Value set de Tipos de servicios asistenciales para ÚNICAS (preferred): Value set de Tipos de servicios asistenciales para ÚNICAS
.... coding
..... system 0..1 uri OID del catálogo de clasificación de Servicios
..... code 0..1 code Código del servicio asistencial para ÚNICAS
..... display 0..1 string Descripción del servicio asistencial para ÚNICAS
... serviceType 0..* CodeableReference(HealthcareService) Canal de cita
Binding: Value set de Canales de cita (preferred): Value set de Canales de cita
.... concept 0..1 CodeableConcept Canal de cita
..... coding
...... system 0..1 uri URL del SNOMED CT. Extensión para España del SNS
...... code 0..1 code Código del canal de cita
...... display 0..1 string Descripción del canal de cita
.... concept 0..1 CodeableConcept Motivo de cita
..... coding
...... system 1..1 uri URL del SNOMED CT. Extensión para España del SNS | OID del CIE-10-ES. Diagnósticos | OID del ORPHA
...... code 1..1 code Código del motivo de la cita
...... display 1..1 string Descripción del motivo de la cita
... start 1..1 instant Fecha y hora de inicio de la cita programada
... end 0..1 instant Fecha y hora de fin de la cita programada
... minutesDuration 0..1 positiveInt Duración de la cita programada
... created 0..1 dateTime Fecha y hora de creación de la cita
... cancellationDate 0..1 dateTime Fecha y hora de cancelación de la cita
... note 0..* Annotation Comentario
.... text 1..1 markdown Comentario
... subject 1..1 Reference(Patient Paciente ÚNICAS) Referencia al paciente
.... reference 0..1 string Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
.... type 1..1 uri Tipo de recurso FHIR
.... identifier 1..1 Identifier Identificador de paciente CIP-SNS. Cuando no tengamos recurso Patient, se debera informar el identificador de paciente mediante CIP-SNS
..... type 0..1 CodeableConcept Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
...... coding
....... system 0..1 uri URL del SNOMED CT. Extensión para España del SNS
....... code 0..1 code Código del identificador
....... display 0..1 string Decripción del identificador
..... system 0..1 uri OID registro de número de CIP-SNS
..... value 0..1 string Número CIP-SNS
.... display 0..1 string Nombre completo del paciente
... Slices for participant 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by profile:resource
.... participant:ProfesionalSanitarioParticipante 1..* BackboneElement Profesional sanitario participante
..... actor 0..1 Reference(PractitionerRole Profesional Sanitario ÚNICAS | Practitioner Profesional Sanitario ÚNICAS) Referencia al profesional sanitario
...... reference 0..1 string Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
...... type 1..1 uri Tipo de recurso FHIR
...... identifier 1..1 Identifier Identificadores del profesional sanitario. Cuando no tengamos recurso Practitioner, se debera informar el identificador del profesional sanitario mediante DNI como dato mínimo. Adicionalmente, se puede informar el número colegiado del profesional sanitario como dato recomendado
....... Slices for extension Content/Rules for all slices
........ extension:numeroColegiadoProfesionalSanitario 0..* Identifier Número de colegiado del profesional sanitario
URL: https://unicas-fhir.sanidad.gob.es/StructureDefinition/NumeroColegiadoProfesionalSanitario
....... type 0..1 CodeableConcept Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
........ coding
......... system 0..1 uri URL del refset Tipos de documento para identificación personal de SNOMED CT. Extensión para España del SNS
......... code 0..1 code Código del identificador
......... display 0..1 string Decripción del identificador
....... system 0..1 uri OID registro de DNI
....... value 0..1 string Número del DNI
...... display 0..1 string Nombre completo del profesional sanitario
.... participant:ServicioAsistencialParticipante 1..* BackboneElement Servicio asistencial (Localización) participante
..... actor 0..1 Reference(Location Localización y Servicio Asistencial ÚNICAS) Referencia a la localización y servicio asistencial
...... reference 0..1 string Referencia recurso FHIR
...... type 0..1 uri Tipo de recurso FHIR
...... identifier 0..1 Identifier Identificador del recurso FHIR
....... system 0..1 uri Sistema para identificar el origen
....... value 0..1 string Identificador interno del sistema para la localización

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Appointment.serviceCategorypreferredValuesetTiposServiciosAsistenciales
https://unicas-fhir.sanidad.gob.es/ValueSet/TiposServicios
From this IG
Appointment.serviceTypepreferredValuesetCanalesCita
https://unicas-fhir.sanidad.gob.es/ValueSet/CanalesCita
From this IG
Appointment.reasonpreferredValuesetMotivosCita
https://unicas-fhir.sanidad.gob.es/ValueSet/MotivosCita
From this IG
Appointment.subject.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
regcess-systemwarningAppointment.identifier.systemsystem debe comenzar por urn:regcess: seguido del identificador del sistema.
: matches('^urn:regcess:[A-Za-z0-9]+$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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)
Constraints: app-2, app-3, app-4, app-5, app-6, app-7
... 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
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier Identificador único
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system ΣC 1..1 uri Sistema para identificar el origen
Constraints: regcess-system
Example General: urn:regcess:0123456789
.... value ΣC 1..1 string Identificador interno del sistema para la cita programada
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 ?!ΣC 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... 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 Σ 0..* CodeableConcept Categorización de la cita
Binding: Value set de Tipos de servicios asistenciales para ÚNICAS (preferred): Value set de Tipos de servicios asistenciales para ÚNICAS
.... 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 Σ 0..* 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 OID del catálogo de clasificación de Servicios
..... version Σ 0..1 string Version of the system - if relevant
..... code ΣC 0..1 code Código del servicio asistencial para ÚNICAS
..... display ΣC 0..1 string Descripción del servicio asistencial para ÚNICAS
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... serviceType Σ 0..* CodeableReference(HealthcareService) Canal de cita
Binding: Value set de Canales de cita (preferred): Value set de Canales de cita
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ 0..1 CodeableConcept Canal de cita
..... 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 Σ 0..* 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 URL del SNOMED CT. Extensión para España del SNS
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Código del canal de cita
...... display ΣC 0..1 string Descripción del canal de cita
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... reference Σ 0..1 Reference() Reference to a resource (by instance)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... 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 Σ 1..* CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) Motivo de cita
Binding: Value set de Motivos de la cita (preferred): Value set de Motivos de la cita
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ 0..1 CodeableConcept Motivo de cita
..... 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 Σ 0..* 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 Σ 1..1 uri URL del SNOMED CT. Extensión para España del SNS | OID del CIE-10-ES. Diagnósticos | OID del ORPHA
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 1..1 code Código del motivo de la cita
...... display ΣC 1..1 string Descripción del motivo de la cita
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... reference Σ 0..1 Reference() Reference to a resource (by instance)
... 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 ΣC 1..1 instant Fecha y hora de inicio de la cita programada
... end ΣC 0..1 instant Fecha y hora de fin de la cita programada
... minutesDuration 0..1 positiveInt Duración de la cita programada
... 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 Fecha y hora de creación de la cita
... cancellationDate C 0..1 dateTime Fecha y hora de cancelación de la cita
... note 0..* Annotation Comentario
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown Comentario
... 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 Σ 1..1 Reference(Patient Paciente ÚNICAS) Referencia al paciente
.... 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 Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
.... type Σ 1..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 1..1 Identifier Identificador de paciente CIP-SNS. Cuando no tengamos recurso Patient, se debera informar el identificador de paciente mediante CIP-SNS
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 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 Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
...... 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 Σ 0..* 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 URL del SNOMED CT. Extensión para España del SNS
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 0..1 code Código del identificador
....... display ΣC 0..1 string Decripción del identificador
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri OID registro de número de CIP-SNS
Example General: urn:oid:2.16.724.4.40
..... value ΣC 0..1 string Número CIP-SNS
Example General: BBBBBBBBQR648597
..... 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)
.... display ΣC 0..1 string Nombre completo del paciente
... Slices for participant C 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by profile:resource
Constraints: app-1
.... 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 Σ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 0..1 Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) The individual, device, location, or service participating in the appointment
..... required Σ 0..1 boolean The participant is required to attend (optional when false)
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:ProfesionalSanitarioParticipante C 1..* BackboneElement Profesional sanitario participante
Constraints: app-1
..... 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 0..1 Reference(PractitionerRole Profesional Sanitario ÚNICAS | Practitioner Profesional Sanitario ÚNICAS) Referencia al profesional sanitario
...... 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 Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
...... type Σ 1..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier ΣC 1..1 Identifier Identificadores del profesional sanitario. Cuando no tengamos recurso Practitioner, se debera informar el identificador del profesional sanitario mediante DNI como dato mínimo. Adicionalmente, se puede informar el número colegiado del profesional sanitario como dato recomendado
....... id 0..1 id Unique id for inter-element referencing
....... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ extension:numeroColegiadoProfesionalSanitario 0..* Identifier Número de colegiado del profesional sanitario
URL: https://unicas-fhir.sanidad.gob.es/StructureDefinition/NumeroColegiadoProfesionalSanitario
....... use ?!Σ 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 Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
........ 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 Σ 0..* 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 URL del refset Tipos de documento para identificación personal de SNOMED CT. Extensión para España del SNS
......... version Σ 0..1 string Version of the system - if relevant
......... code ΣC 0..1 code Código del identificador
......... display ΣC 0..1 string Decripción del identificador
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
....... system Σ 0..1 uri OID registro de DNI
Example General: urn:oid:1.3.6.1.4.1.19126.3
....... value ΣC 0..1 string Número del DNI
Example General: 0000001X
....... 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)
...... display ΣC 0..1 string Nombre completo del profesional sanitario
..... required Σ 0..1 boolean The participant is required to attend (optional when false)
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:ServicioAsistencialParticipante C 1..* BackboneElement Servicio asistencial (Localización) participante
Constraints: app-1
..... 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 0..1 Reference(Location Localización y Servicio Asistencial ÚNICAS) Referencia a la localización y servicio asistencial
...... 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 Referencia recurso FHIR
...... type Σ 0..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier ΣC 0..1 Identifier Identificador del recurso FHIR
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri Sistema para identificar el origen
Example General: urn:regcess:0123456789
....... value ΣC 0..1 string Identificador interno del sistema para la localización
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)
...... display ΣC 0..1 string Text alternative for the resource
..... required Σ 0..1 boolean The participant is required to attend (optional when false)
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Appointment.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0
From the FHIR Standard
Appointment.cancellationReasonexampleAppointmentCancellationReason
http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
From the FHIR Standard
Appointment.classpreferredhttp://terminology.hl7.org/ValueSet/EncounterClass
http://terminology.hl7.org/ValueSet/EncounterClass
Appointment.serviceCategorypreferredValuesetTiposServiciosAsistenciales
https://unicas-fhir.sanidad.gob.es/ValueSet/TiposServicios
From this IG
Appointment.serviceTypepreferredValuesetCanalesCita
https://unicas-fhir.sanidad.gob.es/ValueSet/CanalesCita
From this IG
Appointment.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
From the FHIR Standard
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonpreferredValuesetMotivosCita
https://unicas-fhir.sanidad.gob.es/ValueSet/MotivosCita
From this IG
Appointment.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Appointment.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.subject.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.subject.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.actor.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard
Appointment.recurrenceTemplate.timezonerequiredIANATimezones
http://hl7.org/fhir/ValueSet/timezones|5.0.0
From the FHIR Standard
Appointment.recurrenceTemplate.recurrenceTypepreferredAppointmentRecurrenceType
http://hl7.org/fhir/ValueSet/appointment-recurrrence-type
From the FHIR Standard
Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonthrequiredWeekOfMonth
http://hl7.org/fhir/ValueSet/week-of-month|5.0.0
From the FHIR Standard
Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participant, Appointment.participant:ProfesionalSanitarioParticipante, Appointment.participant:ServicioAsistencialParticipanteEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancellation reason is only used for appointments that have been cancelled, or noshow
: cancellationReason.exists() implies (status='noshow' or status='cancelled')
app-5errorAppointmentThe start must be less than or equal to the end
: start.exists() implies start <= end
app-6best practiceAppointmentAn appointment may have an originatingAppointment or recurrenceTemplate, but not both
: originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
app-7errorAppointmentCancellation date is only used for appointments that have been cancelled, or noshow
: cancellationDate.exists() implies (status='noshow' or status='cancelled')
dom-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
regcess-systemwarningAppointment.identifier.systemsystem debe comenzar por urn:regcess: seguido del identificador del sistema.
: matches('^urn:regcess:[A-Za-z0-9]+$')

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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)
Constraints: app-2, app-3, app-4, app-5, app-6, app-7
... 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
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system ΣC 1..1 uri Sistema para identificar el origen
Constraints: regcess-system
Example General: urn:regcess:0123456789
.... value ΣC 1..1 string Identificador interno del sistema para la cita programada
Example General: 123456
... status ?!ΣC 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... serviceCategory Σ 0..* CodeableConcept Categorización de la cita
Binding: Value set de Tipos de servicios asistenciales para ÚNICAS (preferred): Value set de Tipos de servicios asistenciales para ÚNICAS
... serviceType Σ 0..* CodeableReference(HealthcareService) Canal de cita
Binding: Value set de Canales de cita (preferred): Value set de Canales de cita
.... concept Σ 0..1 CodeableConcept Canal de cita
... reason Σ 1..* CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) Motivo de cita
Binding: Value set de Motivos de la cita (preferred): Value set de Motivos de la cita
.... concept Σ 0..1 CodeableConcept Motivo de cita
... start ΣC 1..1 instant Fecha y hora de inicio de la cita programada
... end ΣC 0..1 instant Fecha y hora de fin de la cita programada
... minutesDuration 0..1 positiveInt Duración de la cita programada
... created 0..1 dateTime Fecha y hora de creación de la cita
... cancellationDate C 0..1 dateTime Fecha y hora de cancelación de la cita
... note 0..* Annotation Comentario
.... text Σ 1..1 markdown Comentario
... subject Σ 1..1 Reference(Patient Paciente ÚNICAS) Referencia al paciente
.... reference ΣC 0..1 string Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
.... type Σ 1..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 1..1 Identifier Identificador de paciente CIP-SNS. Cuando no tengamos recurso Patient, se debera informar el identificador de paciente mediante CIP-SNS
..... use ?!Σ 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 Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
..... system Σ 0..1 uri OID registro de número de CIP-SNS
Example General: urn:oid:2.16.724.4.40
..... value ΣC 0..1 string Número CIP-SNS
Example General: BBBBBBBBQR648597
.... display ΣC 0..1 string Nombre completo del paciente
... Slices for participant C 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by profile:resource
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:ProfesionalSanitarioParticipante C 1..* BackboneElement Profesional sanitario participante
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor ΣC 0..1 Reference(PractitionerRole Profesional Sanitario ÚNICAS | Practitioner Profesional Sanitario ÚNICAS) Referencia al profesional sanitario
...... reference ΣC 0..1 string Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
...... type Σ 1..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier ΣC 1..1 Identifier Identificadores del profesional sanitario. Cuando no tengamos recurso Practitioner, se debera informar el identificador del profesional sanitario mediante DNI como dato mínimo. Adicionalmente, se puede informar el número colegiado del profesional sanitario como dato recomendado
....... Slices for extension Content/Rules for all slices
........ extension:numeroColegiadoProfesionalSanitario 0..* Identifier Número de colegiado del profesional sanitario
URL: https://unicas-fhir.sanidad.gob.es/StructureDefinition/NumeroColegiadoProfesionalSanitario
....... use ?!Σ 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 Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
....... system Σ 0..1 uri OID registro de DNI
Example General: urn:oid:1.3.6.1.4.1.19126.3
....... value ΣC 0..1 string Número del DNI
Example General: 0000001X
...... display ΣC 0..1 string Nombre completo del profesional sanitario
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:ServicioAsistencialParticipante C 1..* BackboneElement Servicio asistencial (Localización) participante
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor ΣC 0..1 Reference(Location Localización y Servicio Asistencial ÚNICAS) Referencia a la localización y servicio asistencial
...... reference ΣC 0..1 string Referencia recurso FHIR
...... type Σ 0..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier ΣC 0..1 Identifier Identificador del recurso FHIR
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 0..1 uri Sistema para identificar el origen
Example General: urn:regcess:0123456789
....... value ΣC 0..1 string Identificador interno del sistema para la localización
Example General: 123456
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0
From the FHIR Standard
Appointment.serviceCategorypreferredValuesetTiposServiciosAsistenciales
https://unicas-fhir.sanidad.gob.es/ValueSet/TiposServicios
From this IG
Appointment.serviceTypepreferredValuesetCanalesCita
https://unicas-fhir.sanidad.gob.es/ValueSet/CanalesCita
From this IG
Appointment.reasonpreferredValuesetMotivosCita
https://unicas-fhir.sanidad.gob.es/ValueSet/MotivosCita
From this IG
Appointment.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.subject.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.subject.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participant, Appointment.participant:ProfesionalSanitarioParticipante, Appointment.participant:ServicioAsistencialParticipanteEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancellation reason is only used for appointments that have been cancelled, or noshow
: cancellationReason.exists() implies (status='noshow' or status='cancelled')
app-5errorAppointmentThe start must be less than or equal to the end
: start.exists() implies start <= end
app-6best practiceAppointmentAn appointment may have an originatingAppointment or recurrenceTemplate, but not both
: originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
app-7errorAppointmentCancellation date is only used for appointments that have been cancelled, or noshow
: cancellationDate.exists() implies (status='noshow' or status='cancelled')
dom-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
regcess-systemwarningAppointment.identifier.systemsystem debe comenzar por urn:regcess: seguido del identificador del sistema.
: matches('^urn:regcess:[A-Za-z0-9]+$')

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment Appointment
... identifier 1..* Identifier Identificador único
.... system C 1..1 uri Sistema para identificar el origen
Constraints: regcess-system
.... value 1..1 string Identificador interno del sistema para la cita programada
... serviceCategory 0..* CodeableConcept Categorización de la cita
Binding: Value set de Tipos de servicios asistenciales para ÚNICAS (preferred): Value set de Tipos de servicios asistenciales para ÚNICAS
.... coding
..... system 0..1 uri OID del catálogo de clasificación de Servicios
..... code 0..1 code Código del servicio asistencial para ÚNICAS
..... display 0..1 string Descripción del servicio asistencial para ÚNICAS
... serviceType 0..* CodeableReference(HealthcareService) Canal de cita
Binding: Value set de Canales de cita (preferred): Value set de Canales de cita
.... concept 0..1 CodeableConcept Canal de cita
..... coding
...... system 0..1 uri URL del SNOMED CT. Extensión para España del SNS
...... code 0..1 code Código del canal de cita
...... display 0..1 string Descripción del canal de cita
.... concept 0..1 CodeableConcept Motivo de cita
..... coding
...... system 1..1 uri URL del SNOMED CT. Extensión para España del SNS | OID del CIE-10-ES. Diagnósticos | OID del ORPHA
...... code 1..1 code Código del motivo de la cita
...... display 1..1 string Descripción del motivo de la cita
... start 1..1 instant Fecha y hora de inicio de la cita programada
... end 0..1 instant Fecha y hora de fin de la cita programada
... minutesDuration 0..1 positiveInt Duración de la cita programada
... created 0..1 dateTime Fecha y hora de creación de la cita
... cancellationDate 0..1 dateTime Fecha y hora de cancelación de la cita
... note 0..* Annotation Comentario
.... text 1..1 markdown Comentario
... subject 1..1 Reference(Patient Paciente ÚNICAS) Referencia al paciente
.... reference 0..1 string Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
.... type 1..1 uri Tipo de recurso FHIR
.... identifier 1..1 Identifier Identificador de paciente CIP-SNS. Cuando no tengamos recurso Patient, se debera informar el identificador de paciente mediante CIP-SNS
..... type 0..1 CodeableConcept Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
...... coding
....... system 0..1 uri URL del SNOMED CT. Extensión para España del SNS
....... code 0..1 code Código del identificador
....... display 0..1 string Decripción del identificador
..... system 0..1 uri OID registro de número de CIP-SNS
..... value 0..1 string Número CIP-SNS
.... display 0..1 string Nombre completo del paciente
... Slices for participant 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by profile:resource
.... participant:ProfesionalSanitarioParticipante 1..* BackboneElement Profesional sanitario participante
..... actor 0..1 Reference(PractitionerRole Profesional Sanitario ÚNICAS | Practitioner Profesional Sanitario ÚNICAS) Referencia al profesional sanitario
...... reference 0..1 string Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
...... type 1..1 uri Tipo de recurso FHIR
...... identifier 1..1 Identifier Identificadores del profesional sanitario. Cuando no tengamos recurso Practitioner, se debera informar el identificador del profesional sanitario mediante DNI como dato mínimo. Adicionalmente, se puede informar el número colegiado del profesional sanitario como dato recomendado
....... Slices for extension Content/Rules for all slices
........ extension:numeroColegiadoProfesionalSanitario 0..* Identifier Número de colegiado del profesional sanitario
URL: https://unicas-fhir.sanidad.gob.es/StructureDefinition/NumeroColegiadoProfesionalSanitario
....... type 0..1 CodeableConcept Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
........ coding
......... system 0..1 uri URL del refset Tipos de documento para identificación personal de SNOMED CT. Extensión para España del SNS
......... code 0..1 code Código del identificador
......... display 0..1 string Decripción del identificador
....... system 0..1 uri OID registro de DNI
....... value 0..1 string Número del DNI
...... display 0..1 string Nombre completo del profesional sanitario
.... participant:ServicioAsistencialParticipante 1..* BackboneElement Servicio asistencial (Localización) participante
..... actor 0..1 Reference(Location Localización y Servicio Asistencial ÚNICAS) Referencia a la localización y servicio asistencial
...... reference 0..1 string Referencia recurso FHIR
...... type 0..1 uri Tipo de recurso FHIR
...... identifier 0..1 Identifier Identificador del recurso FHIR
....... system 0..1 uri Sistema para identificar el origen
....... value 0..1 string Identificador interno del sistema para la localización

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Appointment.serviceCategorypreferredValuesetTiposServiciosAsistenciales
https://unicas-fhir.sanidad.gob.es/ValueSet/TiposServicios
From this IG
Appointment.serviceTypepreferredValuesetCanalesCita
https://unicas-fhir.sanidad.gob.es/ValueSet/CanalesCita
From this IG
Appointment.reasonpreferredValuesetMotivosCita
https://unicas-fhir.sanidad.gob.es/ValueSet/MotivosCita
From this IG
Appointment.subject.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
regcess-systemwarningAppointment.identifier.systemsystem debe comenzar por urn:regcess: seguido del identificador del sistema.
: matches('^urn:regcess:[A-Za-z0-9]+$')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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)
Constraints: app-2, app-3, app-4, app-5, app-6, app-7
... 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
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier Identificador único
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system ΣC 1..1 uri Sistema para identificar el origen
Constraints: regcess-system
Example General: urn:regcess:0123456789
.... value ΣC 1..1 string Identificador interno del sistema para la cita programada
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 ?!ΣC 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... 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 Σ 0..* CodeableConcept Categorización de la cita
Binding: Value set de Tipos de servicios asistenciales para ÚNICAS (preferred): Value set de Tipos de servicios asistenciales para ÚNICAS
.... 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 Σ 0..* 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 OID del catálogo de clasificación de Servicios
..... version Σ 0..1 string Version of the system - if relevant
..... code ΣC 0..1 code Código del servicio asistencial para ÚNICAS
..... display ΣC 0..1 string Descripción del servicio asistencial para ÚNICAS
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... serviceType Σ 0..* CodeableReference(HealthcareService) Canal de cita
Binding: Value set de Canales de cita (preferred): Value set de Canales de cita
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ 0..1 CodeableConcept Canal de cita
..... 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 Σ 0..* 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 URL del SNOMED CT. Extensión para España del SNS
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Código del canal de cita
...... display ΣC 0..1 string Descripción del canal de cita
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... reference Σ 0..1 Reference() Reference to a resource (by instance)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... 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 Σ 1..* CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) Motivo de cita
Binding: Value set de Motivos de la cita (preferred): Value set de Motivos de la cita
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ 0..1 CodeableConcept Motivo de cita
..... 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 Σ 0..* 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 Σ 1..1 uri URL del SNOMED CT. Extensión para España del SNS | OID del CIE-10-ES. Diagnósticos | OID del ORPHA
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 1..1 code Código del motivo de la cita
...... display ΣC 1..1 string Descripción del motivo de la cita
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... reference Σ 0..1 Reference() Reference to a resource (by instance)
... 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 ΣC 1..1 instant Fecha y hora de inicio de la cita programada
... end ΣC 0..1 instant Fecha y hora de fin de la cita programada
... minutesDuration 0..1 positiveInt Duración de la cita programada
... 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 Fecha y hora de creación de la cita
... cancellationDate C 0..1 dateTime Fecha y hora de cancelación de la cita
... note 0..* Annotation Comentario
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown Comentario
... 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 Σ 1..1 Reference(Patient Paciente ÚNICAS) Referencia al paciente
.... 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 Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
.... type Σ 1..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 1..1 Identifier Identificador de paciente CIP-SNS. Cuando no tengamos recurso Patient, se debera informar el identificador de paciente mediante CIP-SNS
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 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 Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
...... 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 Σ 0..* 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 URL del SNOMED CT. Extensión para España del SNS
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 0..1 code Código del identificador
....... display ΣC 0..1 string Decripción del identificador
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri OID registro de número de CIP-SNS
Example General: urn:oid:2.16.724.4.40
..... value ΣC 0..1 string Número CIP-SNS
Example General: BBBBBBBBQR648597
..... 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)
.... display ΣC 0..1 string Nombre completo del paciente
... Slices for participant C 2..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by profile:resource
Constraints: app-1
.... 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 Σ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 0..1 Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) The individual, device, location, or service participating in the appointment
..... required Σ 0..1 boolean The participant is required to attend (optional when false)
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:ProfesionalSanitarioParticipante C 1..* BackboneElement Profesional sanitario participante
Constraints: app-1
..... 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 0..1 Reference(PractitionerRole Profesional Sanitario ÚNICAS | Practitioner Profesional Sanitario ÚNICAS) Referencia al profesional sanitario
...... 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 Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR
...... type Σ 1..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier ΣC 1..1 Identifier Identificadores del profesional sanitario. Cuando no tengamos recurso Practitioner, se debera informar el identificador del profesional sanitario mediante DNI como dato mínimo. Adicionalmente, se puede informar el número colegiado del profesional sanitario como dato recomendado
....... id 0..1 id Unique id for inter-element referencing
....... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ extension:numeroColegiadoProfesionalSanitario 0..* Identifier Número de colegiado del profesional sanitario
URL: https://unicas-fhir.sanidad.gob.es/StructureDefinition/NumeroColegiadoProfesionalSanitario
....... use ?!Σ 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 Tipos de documentos de identificación para persona ÚNICAS
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Additional BindingsPurposeDocumentation
Value set de Tipos de documentos de identificación para persona ÚNICAS Extensible
........ 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 Σ 0..* 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 URL del refset Tipos de documento para identificación personal de SNOMED CT. Extensión para España del SNS
......... version Σ 0..1 string Version of the system - if relevant
......... code ΣC 0..1 code Código del identificador
......... display ΣC 0..1 string Decripción del identificador
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
....... system Σ 0..1 uri OID registro de DNI
Example General: urn:oid:1.3.6.1.4.1.19126.3
....... value ΣC 0..1 string Número del DNI
Example General: 0000001X
....... 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)
...... display ΣC 0..1 string Nombre completo del profesional sanitario
..... required Σ 0..1 boolean The participant is required to attend (optional when false)
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:ServicioAsistencialParticipante C 1..* BackboneElement Servicio asistencial (Localización) participante
Constraints: app-1
..... 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 0..1 Reference(Location Localización y Servicio Asistencial ÚNICAS) Referencia a la localización y servicio asistencial
...... 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 Referencia recurso FHIR
...... type Σ 0..1 uri Tipo de recurso FHIR
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier ΣC 0..1 Identifier Identificador del recurso FHIR
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri Sistema para identificar el origen
Example General: urn:regcess:0123456789
....... value ΣC 0..1 string Identificador interno del sistema para la localización
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)
...... display ΣC 0..1 string Text alternative for the resource
..... required Σ 0..1 boolean The participant is required to attend (optional when false)
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Appointment.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0
From the FHIR Standard
Appointment.cancellationReasonexampleAppointmentCancellationReason
http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
From the FHIR Standard
Appointment.classpreferredhttp://terminology.hl7.org/ValueSet/EncounterClass
http://terminology.hl7.org/ValueSet/EncounterClass
Appointment.serviceCategorypreferredValuesetTiposServiciosAsistenciales
https://unicas-fhir.sanidad.gob.es/ValueSet/TiposServicios
From this IG
Appointment.serviceTypepreferredValuesetCanalesCita
https://unicas-fhir.sanidad.gob.es/ValueSet/CanalesCita
From this IG
Appointment.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
From the FHIR Standard
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonpreferredValuesetMotivosCita
https://unicas-fhir.sanidad.gob.es/ValueSet/MotivosCita
From this IG
Appointment.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Appointment.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.subject.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.subject.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.actor.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant:ProfesionalSanitarioParticipante.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.actor.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Appointment.participant:ServicioAsistencialParticipante.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|5.0.0
From the FHIR Standard
Appointment.recurrenceTemplate.timezonerequiredIANATimezones
http://hl7.org/fhir/ValueSet/timezones|5.0.0
From the FHIR Standard
Appointment.recurrenceTemplate.recurrenceTypepreferredAppointmentRecurrenceType
http://hl7.org/fhir/ValueSet/appointment-recurrrence-type
From the FHIR Standard
Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonthrequiredWeekOfMonth
http://hl7.org/fhir/ValueSet/week-of-month|5.0.0
From the FHIR Standard
Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participant, Appointment.participant:ProfesionalSanitarioParticipante, Appointment.participant:ServicioAsistencialParticipanteEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancellation reason is only used for appointments that have been cancelled, or noshow
: cancellationReason.exists() implies (status='noshow' or status='cancelled')
app-5errorAppointmentThe start must be less than or equal to the end
: start.exists() implies start <= end
app-6best practiceAppointmentAn appointment may have an originatingAppointment or recurrenceTemplate, but not both
: originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
app-7errorAppointmentCancellation date is only used for appointments that have been cancelled, or noshow
: cancellationDate.exists() implies (status='noshow' or status='cancelled')
dom-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
regcess-systemwarningAppointment.identifier.systemsystem debe comenzar por urn:regcess: seguido del identificador del sistema.
: matches('^urn:regcess:[A-Za-z0-9]+$')

 

Other representations of profile: CSV, Excel, Schematron

ÚNICAS está impulsado por el Consejo Interterritorial del Sistema Nacional de Salud, y financiado con fondos Next Generation de la Unión Europea, en el marco del Plan de Recuperación, Transformación y Resiliencia del Gobierno de España. El Ministerio de Sanidad ejerce la coordinación del proyecto, y Cataluña lidera la parte del desarrollo de los activos tecnológicos para su implementación.

null