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

Guia de implementação do Core do Brasil: Release 1 - BR Realm | STU1 - Downloaded Version 1.0.0 See the Directory of published versions

## Resource Profile: BRCoreAppointment - Descrições detalhadas

Active as of 2026-07-25

Definitions for the br-core-appointment resource profile.

- Tabela de elementos diferenciais
- Tabela de elementos -chave
- Tabela de elementos de instantâneo

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. Appointment
2. Appointment.id
Definição | Identificador lógico deste artefato
Curto | Identificador lógico deste artefato
4. Appointment.meta
Definição | Metadados sobre o recurso
Curto | Metadados sobre o recurso
6. Appointment.implicitRules
Definição | Um conjunto de regras sob as quais este conteúdo foi criado
Curto | Conjunto de regras usadas para criar o conteúdo
8. Appointment.language
Definição | Idioma do recurso
Curto | Idioma do recurso
10. Appointment.text
Definição | Resumo do texto do recurso em linguagem natural
Curto | Resumo narrativo em linguagem natural
12. Appointment.contained
Definição | Recursos contidos neste recurso
Curto | Recursos aninhados
14. Appointment.extension
Definição | Extensões adicionais que não fazem parte do modelo base
Curto | Extensões adicionais não previstas no modelo base
16. Appointment.modifierExtension
Definição | Extensões adicionais que não podem ser ignoradas, mesmo que não reconhecidas
Curto | Extensões que não podem ser ignoradas
18. Appointment.identifier
Definição | Identificadores para este Appointment (p.ex. identificador do sistema local ou da RNDS)
Curto | Identificadores do agendamento
Nota | Trata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Deve apoiar | true
20. Appointment.status
Definição | Situação atual do agendamento (proposto, pendente, agendado, concluído, cancelado, etc.)
Curto | Status do agendamento
Vínculo | Os códigos DEVERÃO ser retirados de AppointmentStatus (required to `http://hl7.org/fhir/ValueSet/appointmentstatus` )
Deve apoiar | true
22. Appointment.cancelationReason
Definição | Razão codificada para cancelamento do agendamento
Curto | Motivo do cancelamento
Vínculo | Para exemplos de códigos, ver AppointmentCancellationReason (example to `http://hl7.org/fhir/ValueSet/appointment-cancellation-reason` )
24. Appointment.serviceCategory
Definição | Categoria ampla do serviço de saúde
Curto | Categoria do serviço
Vínculo | Os códigos DEVERÃO ser retirados de BR Modalidade Assistencial (preferred to `https://terminologia.saude.gov.br/fhir/ValueSet/BRModalidadeAssistencial` )
26. Appointment.serviceType
Definição | Tipo específico de serviço/atendimento a ser realizado
Curto | Tipo de serviço
Vínculo | Para exemplos de códigos, ver BR Procedimentos Nacionais (example to `https://terminologia.saude.gov.br/fhir/ValueSet/BRProcedimentosNacionais` )
28. Appointment.specialty
Definição | Especialidade clínica requerida para o atendimento
Curto | Especialidade clínica
Vínculo | Os códigos DEVERÃO ser retirados de BR Ocupacao (preferred to `https://terminologia.saude.gov.br/fhir/ValueSet/BROcupacao` )
30. Appointment.appointmentType
Definição | Classificação do agendamento (p.ex. rotina, retorno, encaixe)
Curto | Tipo do agendamento
Vínculo | Os códigos DEVERÃO ser retirados de hl7VS-appointmentReasonCodes (preferred to `http://terminology.hl7.org/ValueSet/v2-0276` )
32. Appointment.reasonCode
Definição | Códigos que expressam a justificativa para o agendamento
Curto | Motivo (código) do agendamento
Vínculo | Os códigos DEVERÃO ser retirados de BRCID 10 (preferred to `https://terminologia.saude.gov.br/fhir/ValueSet/BRCID10` )
34. Appointment.reasonReference
Definição | Referências clínicas (p.ex., Condition, Procedure, Observation) que justificam o agendamento
Curto | Motivo (referência) do agendamento
36. Appointment.priority
Definição | Nível de prioridade do agendamento (inteiro; 0 para rotina, valores maiores indicam maior prioridade)
Curto | Prioridade (0 = rotina)
38. Appointment.description
Definição | Resumo textual do propósito do agendamento
Curto | Descrição livre do agendamento
40. Appointment.supportingInformation
Definição | Referências a recursos que dão contexto ao agendamento (p.ex., DocumentReference, ImagingStudy)
Curto | Informações de apoio
42. Appointment.start
Definição | Data/hora planejada de início do atendimento
Curto | Início planejado
44. Appointment.end
Definição | Data/hora planejada de término do atendimento
Curto | Término planejado
46. Appointment.minutesDuration
Definição | Duração estimada do atendimento em minutos
Curto | Duração prevista (minutos)
48. Appointment.slot
Definição | Slots do agendador reservados para este Appointment
Curto | Slots reservados
50. Appointment.created
Definição | Data em que o agendamento foi criado
Curto | Data de criação
52. Appointment.comment
Definição | Informações adicionais relevantes sobre o agendamento
Curto | Comentários adicionais
54. Appointment.patientInstruction
Definição | Instruções para o paciente sobre o agendamento
Curto | Instruções ao paciente
56. Appointment.basedOn
Definição | Referência à solicitação (ServiceRequest, CarePlan, etc.) que originou o agendamento
Curto | Solicitação que originou o agendamento
58. Appointment.participant
Definição | Participantes envolvidos no agendamento (profissional, paciente, organização, dispositivo, etc.)
Curto | Participantes do agendamento
60. Appointment.participant.type
Definição | Função ou papel do participante no agendamento (p.ex. médico, paciente, intérprete)
Curto | Tipo de participante
Vínculo | A menos que não sejam adequados, estes códigos DEVERÃO ser retirados de BR Tipo Participante (extensible to `https://terminologia.saude.gov.br/fhir/ValueSet/BRTipoParticipante` )
62. Appointment.participant.actor
Definição | Referência ao recurso que representa o participante
Curto | Entidade participante
Tipo | Reference(BRCorePatient, BRCorePractitioner, br-core-healthcareservice)
64. Appointment.participant.required
Definição | Indica se a presença do participante é obrigatória
Curto | Participação obrigatória?
Vínculo | Os códigos DEVERÃO ser retirados de ParticipantRequired (required to `http://hl7.org/fhir/ValueSet/participantrequired` )
66. Appointment.participant.status
Definição | Confirmação do participante (accepted, declined, tentative, needs-action)
Curto | Status de participação
Vínculo | Os códigos DEVERÃO ser retirados de ParticipationStatus (required to `http://hl7.org/fhir/ValueSet/participationstatus` )
68. Appointment.participant.period
Definição | Intervalo de tempo durante o qual o participante está disponível
Curto | Período de disponibilidade
70. Appointment.requestedPeriod
Definição | Período ou faixa de tempo solicitada para o agendamento (antes da confirmação)
Curto | Período solicitado

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. Appointment
Definição | 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).
Curto | 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)
Controlo | 0..*
É modificador | false
Resumo | false
Invariantes | app-2: Either start and end are specified, or neither (`start.exists() = end.exists()`) app-3: Only proposed or cancelled appointments can be missing start/end dates (`(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))`) app-4: 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: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) app-2: Either start and end are specified, or neither (start.exists() = end.exists()) app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))) app-4: 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'))
2. Appointment.id
Definição | Identificador lógico deste artefato The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Curto | Identificador lógico deste artefatoLogical id of this artifact
Comentários | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Controlo | 0..1
Tipo | id string
É modificador | false
Resumo | true
4. Appointment.meta
Definição | Metadados sobre o recurso The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Curto | Metadados sobre o recursoMetadata about the resource
Controlo | 0..1
Tipo | Meta
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Appointment.implicitRules
Definição | Um conjunto de regras sob as quais este conteúdo foi criado A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Curto | Conjunto de regras usadas para criar o conteúdoA set of rules under which this content was created
Comentários | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Controlo | 0..1
Tipo | uri
É modificador | true porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Appointment.language
Definição | Idioma do recurso The base language in which the resource is written.
Curto | Idioma do recursoLanguage of the resource content
Comentários | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Controlo | 0..1
Vínculo | Os códigos DEVERÃO ser retirados de CommonLanguages http://hl7.org/fhir/ValueSet/languages|4.0.1 (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Vínculos adicionais | Objetivo
AllLanguages | Vínculo máximo
Tipo | code
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Appointment.text
Definição | Resumo do texto do recurso em linguagem natural A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Curto | Resumo narrativo em linguagem naturalText summary of the resource, for human interpretation
Comentários | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Controlo | 0..1
Tipo | Narrative
É modificador | false
Resumo | false
Nomes alternativos | narrative, html, xhtml, display
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Appointment.contained
Definição | Recursos contidos neste recurso These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Curto | Recursos aninhadosContained, inline Resources
Comentários | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Controlo | 0..*
Tipo | Resource
É modificador | false
Resumo | false
Nomes alternativos | inline resources, anonymous resources, contained resources
14. Appointment.extension
Definição | Extensões adicionais que não fazem parte do modelo base May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Curto | Extensões adicionais não previstas no modelo baseAdditional content defined by implementations
Comentários | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Controlo | 0..*
Tipo | Extension
É modificador | false
Resumo | false
Nomes alternativos | extensions, user content
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Appointment.modifierExtension
Definição | Extensões adicionais que não podem ser ignoradas, mesmo que não reconhecidas May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Curto | Extensões que não podem ser ignoradasExtensions that cannot be ignored
Comentários | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Resumo | false
Requisitos | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Nomes alternativos | extensions, user content
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Appointment.identifier
Definição | Identificadores para este Appointment (p.ex. identificador do sistema local ou da RNDS) This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
Curto | Identificadores do agendamentoExternal Ids for this item
Nota | Trata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo | 0..*
Tipo | Identifier
É modificador | false
Deve apoiar | true
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Appointment.status
Definição | Situação atual do agendamento (proposto, pendente, agendado, concluído, cancelado, etc.) The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
Curto | Status do agendamentoproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Comentários | If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.
Controlo | 1..1
Vínculo | Os códigos DEVERÃO ser retirados de AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 (required to `http://hl7.org/fhir/ValueSet/appointmentstatus` )
Tipo | code
É modificador | true porque This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Deve apoiar | true
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Appointment.cancelationReason
Definição | Razão codificada para cancelamento do agendamento The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
Curto | Motivo do cancelamentoThe coded reason for the appointment being cancelled
Controlo | 0..1
Vínculo | Para exemplos de códigos, ver AppointmentCancellationReason http://hl7.org/fhir/ValueSet/appointment-cancellation-reason|4.0.1 (example to `http://hl7.org/fhir/ValueSet/appointment-cancellation-reason` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Appointment.serviceCategory
Definição | Categoria ampla do serviço de saúde A broad categorization of the service that is to be performed during this appointment.
Curto | Categoria do serviçoA broad categorization of the service that is to be performed during this appointment
Controlo | 0..*
Vínculo | Os códigos DEVERÃO ser retirados de Para exemplos de códigos, ver BR Modalidade Assistencial http://hl7.org/fhir/ValueSet/service-category|4.0.1 (preferred to `https://terminologia.saude.gov.br/fhir/ValueSet/BRModalidadeAssistencial` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Appointment.serviceType
Definição | Tipo específico de serviço/atendimento a ser realizado The specific service that is to be performed during this appointment.
Curto | Tipo de serviçoThe specific service that is to be performed during this appointment
Comentários | For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.
Controlo | 0..*
Vínculo | Para exemplos de códigos, ver BR Procedimentos Nacionais http://hl7.org/fhir/ValueSet/service-type|4.0.1 (example to `https://terminologia.saude.gov.br/fhir/ValueSet/BRProcedimentosNacionais` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Appointment.specialty
Definição | Especialidade clínica requerida para o atendimento The specialty of a practitioner that would be required to perform the service requested in this appointment.
Curto | Especialidade clínicaThe specialty of a practitioner that would be required to perform the service requested in this appointment
Controlo | 0..*
Vínculo | Os códigos DEVERÃO ser retirados de BR Ocupacao http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1 (preferred to `https://terminologia.saude.gov.br/fhir/ValueSet/BROcupacao` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Appointment.appointmentType
Definição | Classificação do agendamento (p.ex. rotina, retorno, encaixe) The style of appointment or patient that has been booked in the slot (not service type).
Curto | Tipo do agendamentoThe style of appointment or patient that has been booked in the slot (not service type)
Controlo | 0..1
Vínculo | Os códigos DEVERÃO ser retirados de hl7VS-appointmentReasonCodes http://terminology.hl7.org/ValueSet/v2-0276 (preferred to `http://terminology.hl7.org/ValueSet/v2-0276` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Appointment.reasonCode
Definição | Códigos que expressam a justificativa para o agendamento The coded reason that this appointment is being scheduled. This is more clinical than administrative.
Curto | Motivo (código) do agendamentoCoded reason this appointment is scheduled
Controlo | 0..*
Vínculo | Os códigos DEVERÃO ser retirados de BRCID 10 http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1 (preferred to `https://terminologia.saude.gov.br/fhir/ValueSet/BRCID10` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Appointment.reasonReference
Definição | Referências clínicas (p.ex., Condition, Procedure, Observation) que justificam o agendamento Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
Curto | Motivo (referência) do agendamentoReason the appointment is to take place (resource)
Controlo | 0..*
Tipo | Reference(Condition, Procedure, Observation, ImmunizationRecommendation)
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Appointment.priority
Definição | Nível de prioridade do agendamento (inteiro; 0 para rotina, valores maiores indicam maior prioridade) The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
Curto | Prioridade (0 = rotina)Used to make informed decisions if needing to re-prioritize
Comentários | Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.
Controlo | 0..1
Tipo | unsignedInt
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Appointment.description
Definição | Resumo textual do propósito do agendamento The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
Curto | Descrição livre do agendamentoShown on a subject line in a meeting request, or appointment list
Controlo | 0..1
Tipo | string
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Appointment.supportingInformation
Definição | Referências a recursos que dão contexto ao agendamento (p.ex., DocumentReference, ImagingStudy) Additional information to support the appointment provided when making the appointment.
Curto | Informações de apoioAdditional information to support the appointment
Controlo | 0..*
Tipo | Reference(Resource)
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Appointment.start
Definição | Data/hora planejada de início do atendimento Date/Time that the appointment is to take place.
Curto | Início planejadoWhen appointment is to take place
Controlo | 0..1
Tipo | instant
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Appointment.end
Definição | Data/hora planejada de término do atendimento Date/Time that the appointment is to conclude.
Curto | Término planejadoWhen appointment is to conclude
Controlo | 0..1
Tipo | instant
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Appointment.minutesDuration
Definição | Duração estimada do atendimento em minutos Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
Curto | Duração prevista (minutos)Can be less than start/end (e.g. estimate)
Controlo | 0..1
Tipo | positiveInt
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Appointment.slot
Definição | Slots do agendador reservados para este Appointment The slots from the participants' schedules that will be filled by the appointment.
Curto | Slots reservadosThe slots that this appointment is filling
Controlo | 0..*
Tipo | Reference(Slot)
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Appointment.created
Definição | Data em que o agendamento foi criado The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
Curto | Data de criaçãoThe date that this appointment was initially created
Comentários | This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.
Controlo | 0..1
Tipo | dateTime
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Appointment.comment
Definição | Informações adicionais relevantes sobre o agendamento Additional comments about the appointment.
Curto | Comentários adicionaisAdditional comments
Comentários | Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.
Controlo | 0..1
Tipo | string
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Appointment.patientInstruction
Definição | Instruções para o paciente sobre o agendamento While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
Curto | Instruções ao pacienteDetailed information and instructions for the patient
Controlo | 0..1
Tipo | string
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Appointment.basedOn
Definição | Referência à solicitação (ServiceRequest, CarePlan, etc.) que originou o agendamento The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
Curto | Solicitação que originou o agendamentoThe service request this appointment is allocated to assess
Controlo | 0..*
Tipo | Reference(ServiceRequest)
É modificador | false
Resumo | false
Nomes alternativos | incomingReferral
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Appointment.participant
Definição | Participantes envolvidos no agendamento (profissional, paciente, organização, dispositivo, etc.) List of participants involved in the appointment.
Curto | Participantes do agendamentoParticipants involved in appointment
Controlo | 1..*
Tipo | BackboneElement
É modificador | false
Resumo | false
Invariantes | app-1: Either the type or actor on the participant SHALL be specified (`type.exists() or actor.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
60. Appointment.participant.modifierExtension
Definição | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Curto | Extensions that cannot be ignored even if unrecognized
Comentários | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumo | true
Requisitos | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Nomes alternativos | extensions, user content, modifiers
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
62. Appointment.participant.type
Definição | Função ou papel do participante no agendamento (p.ex. médico, paciente, intérprete) Role of participant in the appointment.
Curto | Tipo de participanteRole of participant in the appointment
Comentários | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.
Controlo | 0..*
Vínculo | A menos que não sejam adequados, estes códigos DEVERÃO ser retirados de BR Tipo Participante http://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1 (extensible to `https://terminologia.saude.gov.br/fhir/ValueSet/BRTipoParticipante` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Appointment.participant.actor
Definição | Referência ao recurso que representa o participante A Person, Location/HealthcareService or Device that is participating in the appointment.
Curto | Entidade participantePerson, Location/HealthcareService or Device
Controlo | 0..1
Tipo | Reference(BRCorePatient, BRCorePractitioner, br-core-healthcareservice, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Appointment.participant.required
Definição | Indica se a presença do participante é obrigatória Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.
Curto | Participação obrigatória?required | optional | information-only
Controlo | 0..1
Vínculo | Os códigos DEVERÃO ser retirados de ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 (required to `http://hl7.org/fhir/ValueSet/participantrequired` )
Tipo | code
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Appointment.participant.status
Definição | Confirmação do participante (accepted, declined, tentative, needs-action) Participation status of the actor.
Curto | Status de participaçãoaccepted | declined | tentative | needs-action
Controlo | 1..1
Vínculo | Os códigos DEVERÃO ser retirados de ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 (required to `http://hl7.org/fhir/ValueSet/participationstatus` )
Tipo | code
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Appointment.participant.period
Definição | Intervalo de tempo durante o qual o participante está disponível Participation period of the actor.
Curto | Período de disponibilidadeParticipation period of the actor
Controlo | 0..1
Tipo | Period
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Appointment.requestedPeriod
Definição | Período ou faixa de tempo solicitada para o agendamento (antes da confirmação) A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.
Curto | Período solicitadoPotential date/time interval(s) requested to allocate the appointment within
Comentários | This does not introduce a capacity for recurring appointments.
Controlo | 0..*
Tipo | Period
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. Appointment
Definição | 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).
Curto | 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)
Controlo | 0..*
É modificador | false
Resumo | false
Invariantes | app-2: Either start and end are specified, or neither (`start.exists() = end.exists()`) app-3: Only proposed or cancelled appointments can be missing start/end dates (`(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))`) app-4: 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: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. Appointment.id
Definição | Identificador lógico deste artefato
Curto | Identificador lógico deste artefato
Comentários | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Controlo | 0..1
Tipo | id
É modificador | false
Resumo | true
4. Appointment.meta
Definição | Metadados sobre o recurso
Curto | Metadados sobre o recurso
Controlo | 0..1
Tipo | Meta
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Appointment.implicitRules
Definição | Um conjunto de regras sob as quais este conteúdo foi criado
Curto | Conjunto de regras usadas para criar o conteúdo
Comentários | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Controlo | 0..1
Tipo | uri
É modificador | true porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Appointment.language
Definição | Idioma do recurso
Curto | Idioma do recurso
Comentários | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Controlo | 0..1
Vínculo | Os códigos DEVERÃO ser retirados de CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Vínculos adicionais | Objetivo
AllLanguages | Vínculo máximo
Tipo | code
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Appointment.text
Definição | Resumo do texto do recurso em linguagem natural
Curto | Resumo narrativo em linguagem natural
Comentários | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Controlo | 0..1
Tipo | Narrative
É modificador | false
Resumo | false
Nomes alternativos | narrative, html, xhtml, display
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Appointment.contained
Definição | Recursos contidos neste recurso
Curto | Recursos aninhados
Comentários | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Controlo | 0..*
Tipo | Resource
É modificador | false
Resumo | false
Nomes alternativos | inline resources, anonymous resources, contained resources
14. Appointment.extension
Definição | Extensões adicionais que não fazem parte do modelo base
Curto | Extensões adicionais não previstas no modelo base
Controlo | 0..*
Tipo | Extension
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. Appointment.modifierExtension
Definição | Extensões adicionais que não podem ser ignoradas, mesmo que não reconhecidas
Curto | Extensões que não podem ser ignoradas
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Appointment.identifier
Definição | Identificadores para este Appointment (p.ex. identificador do sistema local ou da RNDS)
Curto | Identificadores do agendamento
Nota | Trata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo | 0..*
Tipo | Identifier
É modificador | false
Deve apoiar | true
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Appointment.status
Definição | Situação atual do agendamento (proposto, pendente, agendado, concluído, cancelado, etc.)
Curto | Status do agendamento
Comentários | If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.
Controlo | 1..1
Vínculo | Os códigos DEVERÃO ser retirados de AppointmentStatus (required to `http://hl7.org/fhir/ValueSet/appointmentstatus` )
Tipo | code
É modificador | true porque This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Deve apoiar | true
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Appointment.cancelationReason
Definição | Razão codificada para cancelamento do agendamento
Curto | Motivo do cancelamento
Controlo | 0..1
Vínculo | Para exemplos de códigos, ver AppointmentCancellationReason (example to `http://hl7.org/fhir/ValueSet/appointment-cancellation-reason` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. Appointment.serviceCategory
Definição | Categoria ampla do serviço de saúde
Curto | Categoria do serviço
Controlo | 0..*
Vínculo | Os códigos DEVERÃO ser retirados de BR Modalidade Assistencial (preferred to `https://terminologia.saude.gov.br/fhir/ValueSet/BRModalidadeAssistencial` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Appointment.serviceType
Definição | Tipo específico de serviço/atendimento a ser realizado
Curto | Tipo de serviço
Comentários | For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.
Controlo | 0..*
Vínculo | Para exemplos de códigos, ver BR Procedimentos Nacionais (example to `https://terminologia.saude.gov.br/fhir/ValueSet/BRProcedimentosNacionais` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Appointment.specialty
Definição | Especialidade clínica requerida para o atendimento
Curto | Especialidade clínica
Controlo | 0..*
Vínculo | Os códigos DEVERÃO ser retirados de BR Ocupacao (preferred to `https://terminologia.saude.gov.br/fhir/ValueSet/BROcupacao` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Appointment.appointmentType
Definição | Classificação do agendamento (p.ex. rotina, retorno, encaixe)
Curto | Tipo do agendamento
Controlo | 0..1
Vínculo | Os códigos DEVERÃO ser retirados de hl7VS-appointmentReasonCodes (preferred to `http://terminology.hl7.org/ValueSet/v2-0276` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. Appointment.reasonCode
Definição | Códigos que expressam a justificativa para o agendamento
Curto | Motivo (código) do agendamento
Controlo | 0..*
Vínculo | Os códigos DEVERÃO ser retirados de BRCID 10 (preferred to `https://terminologia.saude.gov.br/fhir/ValueSet/BRCID10` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. Appointment.reasonReference
Definição | Referências clínicas (p.ex., Condition, Procedure, Observation) que justificam o agendamento
Curto | Motivo (referência) do agendamento
Controlo | 0..*
Tipo | Reference(Condition, Procedure, Observation, ImmunizationRecommendation)
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Appointment.priority
Definição | Nível de prioridade do agendamento (inteiro; 0 para rotina, valores maiores indicam maior prioridade)
Curto | Prioridade (0 = rotina)
Comentários | Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.
Controlo | 0..1
Tipo | unsignedInt
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. Appointment.description
Definição | Resumo textual do propósito do agendamento
Curto | Descrição livre do agendamento
Controlo | 0..1
Tipo | string
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. Appointment.supportingInformation
Definição | Referências a recursos que dão contexto ao agendamento (p.ex., DocumentReference, ImagingStudy)
Curto | Informações de apoio
Controlo | 0..*
Tipo | Reference(Resource)
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. Appointment.start
Definição | Data/hora planejada de início do atendimento
Curto | Início planejado
Controlo | 0..1
Tipo | instant
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. Appointment.end
Definição | Data/hora planejada de término do atendimento
Curto | Término planejado
Controlo | 0..1
Tipo | instant
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. Appointment.minutesDuration
Definição | Duração estimada do atendimento em minutos
Curto | Duração prevista (minutos)
Controlo | 0..1
Tipo | positiveInt
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Appointment.slot
Definição | Slots do agendador reservados para este Appointment
Curto | Slots reservados
Controlo | 0..*
Tipo | Reference(Slot)
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Appointment.created
Definição | Data em que o agendamento foi criado
Curto | Data de criação
Comentários | This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.
Controlo | 0..1
Tipo | dateTime
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Appointment.comment
Definição | Informações adicionais relevantes sobre o agendamento
Curto | Comentários adicionais
Comentários | Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.
Controlo | 0..1
Tipo | string
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Appointment.patientInstruction
Definição | Instruções para o paciente sobre o agendamento
Curto | Instruções ao paciente
Controlo | 0..1
Tipo | string
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. Appointment.basedOn
Definição | Referência à solicitação (ServiceRequest, CarePlan, etc.) que originou o agendamento
Curto | Solicitação que originou o agendamento
Controlo | 0..*
Tipo | Reference(ServiceRequest)
É modificador | false
Resumo | false
Nomes alternativos | incomingReferral
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Appointment.participant
Definição | Participantes envolvidos no agendamento (profissional, paciente, organização, dispositivo, etc.)
Curto | Participantes do agendamento
Controlo | 1..*
Tipo | BackboneElement
É modificador | false
Resumo | false
Invariantes | app-1: Either the type or actor on the participant SHALL be specified (`type.exists() or actor.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Appointment.participant.id
Definição | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Curto | Unique id for inter-element referencing
Controlo | 0..1
Tipo | string
É modificador | false
Formato XML | No formato XML, esta propriedade é representada como um atributo.
Resumo | false
62. Appointment.participant.extension
Definição | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Curto | Additional content defined by implementations
Comentários | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Controlo | 0..*
Tipo | Extension
É modificador | false
Resumo | false
Nomes alternativos | extensions, user content
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
64. Appointment.participant.modifierExtension
Definição | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Curto | Extensions that cannot be ignored even if unrecognized
Comentários | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Controlo | 0..*
Tipo | Extension
É modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumo | true
Requisitos | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Nomes alternativos | extensions, user content, modifiers
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
66. Appointment.participant.type
Definição | Função ou papel do participante no agendamento (p.ex. médico, paciente, intérprete)
Curto | Tipo de participante
Comentários | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.
Controlo | 0..*
Vínculo | A menos que não sejam adequados, estes códigos DEVERÃO ser retirados de BR Tipo Participante (extensible to `https://terminologia.saude.gov.br/fhir/ValueSet/BRTipoParticipante` )
Tipo | CodeableConcept
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Appointment.participant.actor
Definição | Referência ao recurso que representa o participante
Curto | Entidade participante
Controlo | 0..1
Tipo | Reference(BRCorePatient, BRCorePractitioner, br-core-healthcareservice)
É modificador | false
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. Appointment.participant.required
Definição | Indica se a presença do participante é obrigatória
Curto | Participação obrigatória?
Controlo | 0..1
Vínculo | Os códigos DEVERÃO ser retirados de ParticipantRequired (required to `http://hl7.org/fhir/ValueSet/participantrequired` )
Tipo | code
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Appointment.participant.status
Definição | Confirmação do participante (accepted, declined, tentative, needs-action)
Curto | Status de participação
Controlo | 1..1
Vínculo | Os códigos DEVERÃO ser retirados de ParticipationStatus (required to `http://hl7.org/fhir/ValueSet/participationstatus` )
Tipo | code
É modificador | false
Valor primitivo | Este elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumo | true
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. Appointment.participant.period
Definição | Intervalo de tempo durante o qual o participante está disponível
Curto | Período de disponibilidade
Controlo | 0..1
Tipo | Period
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. Appointment.requestedPeriod
Definição | Período ou faixa de tempo solicitada para o agendamento (antes da confirmação)
Curto | Período solicitado
Comentários | This does not introduce a capacity for recurring appointments.
Controlo | 0..*
Tipo | Period
É modificador | false
Resumo | false
Invariantes | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)