Guia de implementação do Core do Brasil: Release 1 - BR Realm | STU1
1.0.0 - STU1 Brazil flag

This page is part of the Core do Brasil (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: br-core-appointment

URL Canônica: https://br-core.saude.gov.br/fhir/StructureDefinition/br-core-appointment Versão: 1.0.0
Active as of 2026-03-12 Nome computável: BRCoreAppointment

Perfil brasileiro do recurso FHIR R4 Appointment, utilizado para agendamento de atendimentos, procedimentos e interações de cuidado no contexto do SUS, RNDS, saúde suplementar e privada, incluindo marcação, remarcação e cancelamento, bem como gestão de participantes, datas/horários e justificativas.

Usos:

  • Este Perfil não é utilizado por nenhum perfil neste guia de implementação

You can also check for usages in the FHIR IG Statistics

Visões formais do conteúdo do perfil

Descrição de perfis, diferenciais, instantâneos e como as diferentes apresentações funcionam.

Esta estrutura é derivada de Appointment

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Appointment 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
... id 0..1 id Identificador lógico deste artefato
... meta 0..1 Meta Metadados sobre o recurso
... implicitRules 0..1 uri Conjunto de regras usadas para criar o conteúdo
... language 0..1 code Idioma do recurso
... text 0..1 Narrative Resumo narrativo em linguagem natural
... contained 0..* Resource Recursos aninhados
... extension 0..* Extension Extensões adicionais não previstas no modelo base
... modifierExtension 0..* Extension Extensões que não podem ser ignoradas
... identifier S 0..* Identifier Identificadores do agendamento
... status S 1..1 code Status do agendamento
Vínculo: AppointmentStatus (required)
... cancelationReason 0..1 CodeableConcept Motivo do cancelamento
Vínculo: AppointmentCancellationReason (preferred)
... serviceCategory 0..* CodeableConcept Categoria do serviço
Vínculo: BR Modalidade Assistencial MIRA (preferred)
... serviceType 0..* CodeableConcept Tipo de serviço
Vínculo: BR Procedimentos Nacionais (preferred)
... specialty 0..* CodeableConcept Especialidade clínica
Vínculo: BR Ocupacao (preferred)
... appointmentType 0..1 CodeableConcept Tipo do agendamento
Vínculo: hl7VS-appointmentReasonCodes (preferred)
... reasonCode 0..* CodeableConcept Motivo (código) do agendamento
Vínculo: BRCID 10 (preferred)
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Motivo (referência) do agendamento
... priority 0..1 unsignedInt Prioridade (0 = rotina)
... description 0..1 string Descrição livre do agendamento
... supportingInformation 0..* Reference(Resource) Informações de apoio
... start 0..1 instant Início planejado
... end 0..1 instant Término planejado
... minutesDuration 0..1 positiveInt Duração prevista (minutos)
... slot 0..* Reference(Slot) Slots reservados
... created 0..1 dateTime Data de criação
... comment 0..1 string Comentários adicionais
... patientInstruction 0..1 string Instruções ao paciente
... basedOn 0..* Reference(ServiceRequest) Solicitação que originou o agendamento
... participant 1..* BackboneElement Participantes do agendamento
.... type 0..* CodeableConcept Tipo de participante
Vínculo: BR Tipo Participante (extensible)
.... actor 0..1 Reference(BRCorePatient | BRCorePractitioner | br-core-healthcareservice) Entidade participante
.... required 0..1 code Participação obrigatória?
Vínculo: ParticipantRequired (required)
.... status 1..1 code Status de participação
Vínculo: ParticipationStatus (required)
.... period 0..1 Period Período de disponibilidade
... requestedPeriod 0..* Period Período solicitado

doco Documentação para este formato

Terminologia Ligações (Diferencial)

Caminho Estado Utilização Conjunto de valores Versão Fonte
Appointment.status Base required AppointmentStatus 📦4.0.1 a norma FHIR
Appointment.cancelationReason Base preferred Appointment cancellation reason 📦4.0.1 a norma FHIR
Appointment.serviceCategory Base preferred BR Modalidade Assistencial MIRA 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.serviceType Base preferred BR Procedimentos Nacionais 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.specialty Base preferred BR Ocupacao 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.appointmentType Base preferred hl7VS-appointmentReasonCodes 📦3.0.0 THO v7.1
Appointment.reasonCode Base preferred BRCID 10 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​type Base extensible BR Tipo Participante 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​required Base required ParticipantRequired 📦4.0.1 a norma FHIR
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 a norma FHIR
NomeBandeirasCard.TipoDescrição e condicionalismos    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
... id Σ 0..1 id Identificador lógico deste artefato
... meta Σ 0..1 Meta Metadados sobre o recurso
... implicitRules ?!Σ 0..1 uri Conjunto de regras usadas para criar o conteúdo
... language 0..1 code Idioma do recurso
Vínculo: CommonLanguages (preferred): A human language.
Vínculos adicionaisObjetivo
AllLanguages Vínculo máximo
... text 0..1 Narrative Resumo narrativo em linguagem natural
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Recursos aninhados
... extension 0..* Extension Extensões adicionais não previstas no modelo base
... modifierExtension ?! 0..* Extension Extensões que não podem ser ignoradas
... identifier SΣ 0..* Identifier Identificadores do agendamento
... status ?!SΣ 1..1 code Status do agendamento
Vínculo: AppointmentStatus (required)
... cancelationReason Σ 0..1 CodeableConcept Motivo do cancelamento
Vínculo: AppointmentCancellationReason (preferred)
... serviceCategory Σ 0..* CodeableConcept Categoria do serviço
Vínculo: BR Modalidade Assistencial MIRA (preferred)
... serviceType Σ 0..* CodeableConcept Tipo de serviço
Vínculo: BR Procedimentos Nacionais (preferred)
... specialty Σ 0..* CodeableConcept Especialidade clínica
Vínculo: BR Ocupacao (preferred)
... appointmentType Σ 0..1 CodeableConcept Tipo do agendamento
Vínculo: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ 0..* CodeableConcept Motivo (código) do agendamento
Vínculo: BRCID 10 (preferred)
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Motivo (referência) do agendamento
... priority 0..1 unsignedInt Prioridade (0 = rotina)
... description 0..1 string Descrição livre do agendamento
... supportingInformation 0..* Reference(Resource) Informações de apoio
... start Σ 0..1 instant Início planejado
... end Σ 0..1 instant Término planejado
... minutesDuration 0..1 positiveInt Duração prevista (minutos)
... slot 0..* Reference(Slot) Slots reservados
... created 0..1 dateTime Data de criação
... comment 0..1 string Comentários adicionais
... patientInstruction 0..1 string Instruções ao paciente
... basedOn 0..* Reference(ServiceRequest) Solicitação que originou o agendamento
... participant C 1..* BackboneElement Participantes do agendamento
Constraints: app-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept Tipo de participante
Vínculo: BR Tipo Participante (extensible)
.... actor Σ 0..1 Reference(BRCorePatient | BRCorePractitioner | br-core-healthcareservice) Entidade participante
.... required Σ 0..1 code Participação obrigatória?
Vínculo: ParticipantRequired (required)
.... status Σ 1..1 code Status de participação
Vínculo: ParticipationStatus (required)
.... period 0..1 Period Período de disponibilidade
... requestedPeriod 0..* Period Período solicitado

doco Documentação para este formato

Terminologia Ligações

Caminho Estado Utilização Conjunto de valores Versão Fonte
Appointment.language Base preferred Common Languages 📍4.0.1 a norma FHIR
Appointment.status Base required AppointmentStatus 📦4.0.1 a norma FHIR
Appointment.cancelationReason Base preferred Appointment cancellation reason 📦4.0.1 a norma FHIR
Appointment.serviceCategory Base preferred BR Modalidade Assistencial MIRA 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.serviceType Base preferred BR Procedimentos Nacionais 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.specialty Base preferred BR Ocupacao 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.appointmentType Base preferred hl7VS-appointmentReasonCodes 📦3.0.0 THO v7.1
Appointment.reasonCode Base preferred BRCID 10 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​type Base extensible BR Tipo Participante 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​required Base required ParticipantRequired 📦4.0.1 a norma FHIR
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 a norma FHIR

Restrições

Id Grau Caminho(s) Descrição Expressão
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
NomeBandeirasCard.TipoDescrição e condicionalismos    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
... id Σ 0..1 id Identificador lógico deste artefato
... meta Σ 0..1 Meta Metadados sobre o recurso
... implicitRules ?!Σ 0..1 uri Conjunto de regras usadas para criar o conteúdo
... language 0..1 code Idioma do recurso
Vínculo: CommonLanguages (preferred): A human language.
Vínculos adicionaisObjetivo
AllLanguages Vínculo máximo
... text 0..1 Narrative Resumo narrativo em linguagem natural
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Recursos aninhados
... extension 0..* Extension Extensões adicionais não previstas no modelo base
... modifierExtension ?! 0..* Extension Extensões que não podem ser ignoradas
... identifier SΣ 0..* Identifier Identificadores do agendamento
... status ?!SΣ 1..1 code Status do agendamento
Vínculo: AppointmentStatus (required)
... cancelationReason Σ 0..1 CodeableConcept Motivo do cancelamento
Vínculo: AppointmentCancellationReason (preferred)
... serviceCategory Σ 0..* CodeableConcept Categoria do serviço
Vínculo: BR Modalidade Assistencial MIRA (preferred)
... serviceType Σ 0..* CodeableConcept Tipo de serviço
Vínculo: BR Procedimentos Nacionais (preferred)
... specialty Σ 0..* CodeableConcept Especialidade clínica
Vínculo: BR Ocupacao (preferred)
... appointmentType Σ 0..1 CodeableConcept Tipo do agendamento
Vínculo: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ 0..* CodeableConcept Motivo (código) do agendamento
Vínculo: BRCID 10 (preferred)
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Motivo (referência) do agendamento
... priority 0..1 unsignedInt Prioridade (0 = rotina)
... description 0..1 string Descrição livre do agendamento
... supportingInformation 0..* Reference(Resource) Informações de apoio
... start Σ 0..1 instant Início planejado
... end Σ 0..1 instant Término planejado
... minutesDuration 0..1 positiveInt Duração prevista (minutos)
... slot 0..* Reference(Slot) Slots reservados
... created 0..1 dateTime Data de criação
... comment 0..1 string Comentários adicionais
... patientInstruction 0..1 string Instruções ao paciente
... basedOn 0..* Reference(ServiceRequest) Solicitação que originou o agendamento
... participant C 1..* BackboneElement Participantes do agendamento
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 Σ 0..* CodeableConcept Tipo de participante
Vínculo: BR Tipo Participante (extensible)
.... actor Σ 0..1 Reference(BRCorePatient | BRCorePractitioner | br-core-healthcareservice) Entidade participante
.... required Σ 0..1 code Participação obrigatória?
Vínculo: ParticipantRequired (required)
.... status Σ 1..1 code Status de participação
Vínculo: ParticipationStatus (required)
.... period 0..1 Period Período de disponibilidade
... requestedPeriod 0..* Period Período solicitado

doco Documentação para este formato

Terminologia Ligações

Caminho Estado Utilização Conjunto de valores Versão Fonte
Appointment.language Base preferred Common Languages 📍4.0.1 a norma FHIR
Appointment.status Base required AppointmentStatus 📦4.0.1 a norma FHIR
Appointment.cancelationReason Base preferred Appointment cancellation reason 📦4.0.1 a norma FHIR
Appointment.serviceCategory Base preferred BR Modalidade Assistencial MIRA 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.serviceType Base preferred BR Procedimentos Nacionais 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.specialty Base preferred BR Ocupacao 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.appointmentType Base preferred hl7VS-appointmentReasonCodes 📦3.0.0 THO v7.1
Appointment.reasonCode Base preferred BRCID 10 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​type Base extensible BR Tipo Participante 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​required Base required ParticipantRequired 📦4.0.1 a norma FHIR
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 a norma FHIR

Restrições

Id Grau Caminho(s) Descrição Expressão
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Visão diferencial

Esta estrutura é derivada de Appointment

NomeBandeirasCard.TipoDescrição e condicionalismos    Filter: Filtersdoco
.. Appointment 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
... id 0..1 id Identificador lógico deste artefato
... meta 0..1 Meta Metadados sobre o recurso
... implicitRules 0..1 uri Conjunto de regras usadas para criar o conteúdo
... language 0..1 code Idioma do recurso
... text 0..1 Narrative Resumo narrativo em linguagem natural
... contained 0..* Resource Recursos aninhados
... extension 0..* Extension Extensões adicionais não previstas no modelo base
... modifierExtension 0..* Extension Extensões que não podem ser ignoradas
... identifier S 0..* Identifier Identificadores do agendamento
... status S 1..1 code Status do agendamento
Vínculo: AppointmentStatus (required)
... cancelationReason 0..1 CodeableConcept Motivo do cancelamento
Vínculo: AppointmentCancellationReason (preferred)
... serviceCategory 0..* CodeableConcept Categoria do serviço
Vínculo: BR Modalidade Assistencial MIRA (preferred)
... serviceType 0..* CodeableConcept Tipo de serviço
Vínculo: BR Procedimentos Nacionais (preferred)
... specialty 0..* CodeableConcept Especialidade clínica
Vínculo: BR Ocupacao (preferred)
... appointmentType 0..1 CodeableConcept Tipo do agendamento
Vínculo: hl7VS-appointmentReasonCodes (preferred)
... reasonCode 0..* CodeableConcept Motivo (código) do agendamento
Vínculo: BRCID 10 (preferred)
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Motivo (referência) do agendamento
... priority 0..1 unsignedInt Prioridade (0 = rotina)
... description 0..1 string Descrição livre do agendamento
... supportingInformation 0..* Reference(Resource) Informações de apoio
... start 0..1 instant Início planejado
... end 0..1 instant Término planejado
... minutesDuration 0..1 positiveInt Duração prevista (minutos)
... slot 0..* Reference(Slot) Slots reservados
... created 0..1 dateTime Data de criação
... comment 0..1 string Comentários adicionais
... patientInstruction 0..1 string Instruções ao paciente
... basedOn 0..* Reference(ServiceRequest) Solicitação que originou o agendamento
... participant 1..* BackboneElement Participantes do agendamento
.... type 0..* CodeableConcept Tipo de participante
Vínculo: BR Tipo Participante (extensible)
.... actor 0..1 Reference(BRCorePatient | BRCorePractitioner | br-core-healthcareservice) Entidade participante
.... required 0..1 code Participação obrigatória?
Vínculo: ParticipantRequired (required)
.... status 1..1 code Status de participação
Vínculo: ParticipationStatus (required)
.... period 0..1 Period Período de disponibilidade
... requestedPeriod 0..* Period Período solicitado

doco Documentação para este formato

Terminologia Ligações (Diferencial)

Caminho Estado Utilização Conjunto de valores Versão Fonte
Appointment.status Base required AppointmentStatus 📦4.0.1 a norma FHIR
Appointment.cancelationReason Base preferred Appointment cancellation reason 📦4.0.1 a norma FHIR
Appointment.serviceCategory Base preferred BR Modalidade Assistencial MIRA 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.serviceType Base preferred BR Procedimentos Nacionais 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.specialty Base preferred BR Ocupacao 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.appointmentType Base preferred hl7VS-appointmentReasonCodes 📦3.0.0 THO v7.1
Appointment.reasonCode Base preferred BRCID 10 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​type Base extensible BR Tipo Participante 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​required Base required ParticipantRequired 📦4.0.1 a norma FHIR
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 a norma FHIR

Visualização de elementos -chave

NomeBandeirasCard.TipoDescrição e condicionalismos    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
... id Σ 0..1 id Identificador lógico deste artefato
... meta Σ 0..1 Meta Metadados sobre o recurso
... implicitRules ?!Σ 0..1 uri Conjunto de regras usadas para criar o conteúdo
... language 0..1 code Idioma do recurso
Vínculo: CommonLanguages (preferred): A human language.
Vínculos adicionaisObjetivo
AllLanguages Vínculo máximo
... text 0..1 Narrative Resumo narrativo em linguagem natural
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Recursos aninhados
... extension 0..* Extension Extensões adicionais não previstas no modelo base
... modifierExtension ?! 0..* Extension Extensões que não podem ser ignoradas
... identifier SΣ 0..* Identifier Identificadores do agendamento
... status ?!SΣ 1..1 code Status do agendamento
Vínculo: AppointmentStatus (required)
... cancelationReason Σ 0..1 CodeableConcept Motivo do cancelamento
Vínculo: AppointmentCancellationReason (preferred)
... serviceCategory Σ 0..* CodeableConcept Categoria do serviço
Vínculo: BR Modalidade Assistencial MIRA (preferred)
... serviceType Σ 0..* CodeableConcept Tipo de serviço
Vínculo: BR Procedimentos Nacionais (preferred)
... specialty Σ 0..* CodeableConcept Especialidade clínica
Vínculo: BR Ocupacao (preferred)
... appointmentType Σ 0..1 CodeableConcept Tipo do agendamento
Vínculo: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ 0..* CodeableConcept Motivo (código) do agendamento
Vínculo: BRCID 10 (preferred)
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Motivo (referência) do agendamento
... priority 0..1 unsignedInt Prioridade (0 = rotina)
... description 0..1 string Descrição livre do agendamento
... supportingInformation 0..* Reference(Resource) Informações de apoio
... start Σ 0..1 instant Início planejado
... end Σ 0..1 instant Término planejado
... minutesDuration 0..1 positiveInt Duração prevista (minutos)
... slot 0..* Reference(Slot) Slots reservados
... created 0..1 dateTime Data de criação
... comment 0..1 string Comentários adicionais
... patientInstruction 0..1 string Instruções ao paciente
... basedOn 0..* Reference(ServiceRequest) Solicitação que originou o agendamento
... participant C 1..* BackboneElement Participantes do agendamento
Constraints: app-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept Tipo de participante
Vínculo: BR Tipo Participante (extensible)
.... actor Σ 0..1 Reference(BRCorePatient | BRCorePractitioner | br-core-healthcareservice) Entidade participante
.... required Σ 0..1 code Participação obrigatória?
Vínculo: ParticipantRequired (required)
.... status Σ 1..1 code Status de participação
Vínculo: ParticipationStatus (required)
.... period 0..1 Period Período de disponibilidade
... requestedPeriod 0..* Period Período solicitado

doco Documentação para este formato

Terminologia Ligações

Caminho Estado Utilização Conjunto de valores Versão Fonte
Appointment.language Base preferred Common Languages 📍4.0.1 a norma FHIR
Appointment.status Base required AppointmentStatus 📦4.0.1 a norma FHIR
Appointment.cancelationReason Base preferred Appointment cancellation reason 📦4.0.1 a norma FHIR
Appointment.serviceCategory Base preferred BR Modalidade Assistencial MIRA 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.serviceType Base preferred BR Procedimentos Nacionais 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.specialty Base preferred BR Ocupacao 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.appointmentType Base preferred hl7VS-appointmentReasonCodes 📦3.0.0 THO v7.1
Appointment.reasonCode Base preferred BRCID 10 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​type Base extensible BR Tipo Participante 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​required Base required ParticipantRequired 📦4.0.1 a norma FHIR
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 a norma FHIR

Restrições

Id Grau Caminho(s) Descrição Expressão
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Visualização instantânea

NomeBandeirasCard.TipoDescrição e condicionalismos    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
... id Σ 0..1 id Identificador lógico deste artefato
... meta Σ 0..1 Meta Metadados sobre o recurso
... implicitRules ?!Σ 0..1 uri Conjunto de regras usadas para criar o conteúdo
... language 0..1 code Idioma do recurso
Vínculo: CommonLanguages (preferred): A human language.
Vínculos adicionaisObjetivo
AllLanguages Vínculo máximo
... text 0..1 Narrative Resumo narrativo em linguagem natural
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Recursos aninhados
... extension 0..* Extension Extensões adicionais não previstas no modelo base
... modifierExtension ?! 0..* Extension Extensões que não podem ser ignoradas
... identifier SΣ 0..* Identifier Identificadores do agendamento
... status ?!SΣ 1..1 code Status do agendamento
Vínculo: AppointmentStatus (required)
... cancelationReason Σ 0..1 CodeableConcept Motivo do cancelamento
Vínculo: AppointmentCancellationReason (preferred)
... serviceCategory Σ 0..* CodeableConcept Categoria do serviço
Vínculo: BR Modalidade Assistencial MIRA (preferred)
... serviceType Σ 0..* CodeableConcept Tipo de serviço
Vínculo: BR Procedimentos Nacionais (preferred)
... specialty Σ 0..* CodeableConcept Especialidade clínica
Vínculo: BR Ocupacao (preferred)
... appointmentType Σ 0..1 CodeableConcept Tipo do agendamento
Vínculo: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ 0..* CodeableConcept Motivo (código) do agendamento
Vínculo: BRCID 10 (preferred)
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Motivo (referência) do agendamento
... priority 0..1 unsignedInt Prioridade (0 = rotina)
... description 0..1 string Descrição livre do agendamento
... supportingInformation 0..* Reference(Resource) Informações de apoio
... start Σ 0..1 instant Início planejado
... end Σ 0..1 instant Término planejado
... minutesDuration 0..1 positiveInt Duração prevista (minutos)
... slot 0..* Reference(Slot) Slots reservados
... created 0..1 dateTime Data de criação
... comment 0..1 string Comentários adicionais
... patientInstruction 0..1 string Instruções ao paciente
... basedOn 0..* Reference(ServiceRequest) Solicitação que originou o agendamento
... participant C 1..* BackboneElement Participantes do agendamento
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 Σ 0..* CodeableConcept Tipo de participante
Vínculo: BR Tipo Participante (extensible)
.... actor Σ 0..1 Reference(BRCorePatient | BRCorePractitioner | br-core-healthcareservice) Entidade participante
.... required Σ 0..1 code Participação obrigatória?
Vínculo: ParticipantRequired (required)
.... status Σ 1..1 code Status de participação
Vínculo: ParticipationStatus (required)
.... period 0..1 Period Período de disponibilidade
... requestedPeriod 0..* Period Período solicitado

doco Documentação para este formato

Terminologia Ligações

Caminho Estado Utilização Conjunto de valores Versão Fonte
Appointment.language Base preferred Common Languages 📍4.0.1 a norma FHIR
Appointment.status Base required AppointmentStatus 📦4.0.1 a norma FHIR
Appointment.cancelationReason Base preferred Appointment cancellation reason 📦4.0.1 a norma FHIR
Appointment.serviceCategory Base preferred BR Modalidade Assistencial MIRA 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.serviceType Base preferred BR Procedimentos Nacionais 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.specialty Base preferred BR Ocupacao 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.appointmentType Base preferred hl7VS-appointmentReasonCodes 📦3.0.0 THO v7.1
Appointment.reasonCode Base preferred BRCID 10 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​type Base extensible BR Tipo Participante 📦1.0.0 Guia de implementação de Terminologias do Brasil: Release 1 - BR Realm | STU1 v1.0
Appointment.participant.​required Base required ParticipantRequired 📦4.0.1 a norma FHIR
Appointment.participant.​status Base required ParticipationStatus 📦4.0.1 a norma FHIR

Restrições

Id Grau Caminho(s) Descrição Expressão
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Outras representações de perfil: CSV, Excel, Schematron