FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
-
Project FHIR API
This is the location where you can find your resource using a FHIR client.
-
Simplifier FHIR API
The global endpoint is where users can search for all resources in Simplifier. Resources have a globally unique guid Id here.
-
Custom Example generation
Custom Example generation beta
Experiment with resource instance generation using YamlGen and based on this profile.
This feature is in beta. You can help us improve it by giving feedback with the feedback button at the top of the screen.
br-core-appointment
Uma reserva de um evento de saúde entre paciente(s), profissional(es), pessoa(s) relacionada(s) e/ou dispositivo(s) para uma data/hora específica. Isso pode resultar em um ou mais Encontro(s)
Esse não é o repositório oficial da RNDS. Alguns artefatos ainda estão em fase de homologação ("draft"). Para implementação em produção, acesse o Portal de Serviços do DATASUS em: https://servicos-datasus.saude.gov.br
- type Profile on Appointment
- FHIR R4
- status Active
-
version...
This resource matches a canonical claim from this project.
Claim: https://br-core.saude.gov.br/
Canonical claims are used to verify ownership of your canonical URLs.
br-core-appointment (Appointment) | I | Appointment | There are no (further) constraints on this element Element idAppointment 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) DefinitionA 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 | string | Element idAppointment.id Identificador lógico deste artefato. DefinitionIdentificador lógico deste artefato. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | Element idAppointment.meta Metadados sobre o recurso DefinitionMetadados sobre o recurso
|
implicitRules | Σ ?! | 0..1 | uri | Element idAppointment.implicitRules Conjunto de regras sob as quais este conteúdo foi criado DefinitionConjunto de regras sob as quais este conteúdo foi criado 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.
|
language | 0..1 | codeBinding | Element idAppointment.language Idioma do conteúdo do recurso DefinitionIdioma do conteúdo do recurso 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). A human language.
| |
text | 0..1 | Narrative | Element idAppointment.text Resumo do texto do recurso em linguagem natural Alternate namesnarrative, html, xhtml, display DefinitionResumo do texto do recurso em linguagem natural 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.
| |
contained | 0..* | Resource | Element idAppointment.contained Recursos contidos em linha Alternate namesinline resources, anonymous resources, contained resources DefinitionRecursos contidos em linha 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
modifierExtension | ?! I | 0..* | Extension | Element idAppointment.modifierExtension Extensão que não pode ser ignorada Alternate namesextensions, user content DefinitionExtensão que não pode ser ignorada 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. 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.
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idAppointment.identifier External Ids for this item DefinitionThis 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).
|
status | Σ ?! | 1..1 | codeBinding | Element idAppointment.status proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Definitionproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist 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. The free/busy status of an appointment.
|
cancelationReason | Σ | 0..1 | CodeableConcept | Element idAppointment.cancelationReason O motivo codificado para o cancelamento do compromisso DefinitionO motivo codificado para o cancelamento do compromisso AppointmentCancellationReason (example) Constraints
|
serviceCategory | Σ | 1..1 | CodeableConceptBinding | Element idAppointment.serviceCategory Uma ampla categorização do serviço que será realizado durante esta consulta DefinitionUma ampla categorização do serviço que será realizado durante esta consulta https://simplifier.net/redenacionaldedadosemsaude/valueset-brmodalidadeassistencialmira (required) Constraints
|
serviceType | Σ | 1..1 | CodeableConceptBinding | Element idAppointment.serviceType O serviço específico que será realizado durante esta consulta DefinitionO serviço específico que será realizado durante esta consulta 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. https://simplifier.net/redenacionaldedadosemsaude/valueset-brprocedimentosnacionais-1.0 (required) Constraints
|
specialty | Σ | 1..1 | CodeableConceptBinding | Element idAppointment.specialty A especialidade do médico que seria necessário para realizar o serviço solicitado nesta consulta DefinitionA especialidade do médico que seria necessário para realizar o serviço solicitado nesta consulta PracticeSettingCodeValueSet (preferred) Constraints
|
appointmentType | Σ | 1..1 | CodeableConceptBinding | Element idAppointment.appointmentType O estilo de consulta ou paciente que foi agendado no slot (não o tipo de serviço) DefinitionO estilo de consulta ou paciente que foi agendado no slot (não o tipo de serviço)
|
reasonCode | Σ | 0..* | CodeableConceptBinding | Element idAppointment.reasonCode Razão codificada pela qual este compromisso está agendado DefinitionRazão codificada pela qual este compromisso está agendado The Reason for the appointment to take place.
|
reasonReference | 1..1 | Reference(br-core-condition | br-core-procedure | br-core-immunizationrecommendation) | Element idAppointment.reasonReference Razão pela qual a nomeação deve ocorrer (recurso) DefinitionRazão pela qual a nomeação deve ocorrer (recurso) Reference(br-core-condition | br-core-procedure | br-core-immunizationrecommendation) Constraints
| |
priority | 0..1 | unsignedInt | Element idAppointment.priority Usado para tomar decisões informadas se for necessário redefinir prioridades DefinitionUsado para tomar decisões informadas se for necessário redefinir prioridades 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.
| |
description | 0..1 | string | Element idAppointment.description Exibido em uma linha de assunto em uma solicitação de reunião ou lista de compromissos DefinitionExibido em uma linha de assunto em uma solicitação de reunião ou lista de compromissos
| |
supportingInformation | 0..* | Reference(Resource) | Element idAppointment.supportingInformation Informações adicionais para apoiar a nomeação DefinitionInformações adicionais para apoiar a nomeação
| |
start | Σ | 0..1 | instant | Element idAppointment.start Quando a consulta será realizada DefinitionQuando a consulta será realizada
|
end | Σ | 0..1 | instant | Element idAppointment.end Quando a nomeação está para terminar DefinitionQuando a nomeação está para terminar
|
minutesDuration | 0..1 | positiveInt | Element idAppointment.minutesDuration Pode ser menor que início/fim (por exemplo, estimativa) DefinitionPode ser menor que início/fim (por exemplo, estimativa)
| |
slot | 0..* | Reference(Slot) | Element idAppointment.slot As vagas que esta nomeação está preenchendo DefinitionAs vagas que esta nomeação está preenchendo
| |
created | 0..1 | dateTime | Element idAppointment.created A data em que este compromisso foi criado inicialmente DefinitionA data em que este compromisso foi criado inicialmente 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.
| |
comment | 0..1 | string | Element idAppointment.comment Comentários adicionais DefinitionComentários adicionais 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.
| |
patientInstruction | 0..1 | string | Element idAppointment.patientInstruction Informações e instruções detalhadas para o paciente DefinitionInformações e instruções detalhadas para o paciente
| |
basedOn | 0..* | Reference(br-core-servicerequest) | Element idAppointment.basedOn A solicitação de serviço que esta consulta é alocada para avaliar Alternate namesincomingReferral DefinitionA solicitação de serviço que esta consulta é alocada para avaliar Reference(br-core-servicerequest) Constraints
| |
participant | I | 1..* | BackboneElement | Element idAppointment.participant Participantes envolvidos na nomeação DefinitionParticipantes envolvidos na nomeação
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
type | Σ | 0..* | CodeableConceptBinding | Element idAppointment.participant.type Papel do participante na nomeação DefinitionPapel do participante na nomeação 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. Role of participant in encounter.
|
actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Element idAppointment.participant.actor Pessoa, local/serviço de saúde ou dispositivo DefinitionPessoa, local/serviço de saúde ou dispositivo Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.actor.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.actor.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.actor.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idAppointment.participant.actor.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idAppointment.participant.actor.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.actor.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.actor.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.actor.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.participant.actor.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idAppointment.participant.actor.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.actor.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idAppointment.participant.actor.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idAppointment.participant.actor.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.actor.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
required | Σ | 0..1 | codeBinding | Element idAppointment.participant.required required | optional | information-only Definitionrequired | optional | information-only Is the Participant required to attend the appointment.
|
status | Σ | 1..1 | codeBinding | Element idAppointment.participant.status accepted | declined | tentative | needs-action Definitionaccepted | declined | tentative | needs-action The Participation status of an appointment.
|
period | 0..1 | Period | Element idAppointment.participant.period Período de participação do ator DefinitionPeríodo de participação do ator
| |
requestedPeriod | 0..* | Period | Element idAppointment.requestedPeriod Possíveis intervalos de data/hora solicitados para alocar o compromisso dentro DefinitionPossíveis intervalos de data/hora solicitados para alocar o compromisso dentro This does not introduce a capacity for recurring appointments.
|