Arquetipo Appointment
Definición FHIR
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). Appointment Constraints
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idAppointment.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. id Constraints
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAppointment.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Meta Constraints
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAppointment.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. uri Constraints
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.language Language of the resource content DefinitionThe base language in which the resource is written. 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). code BindingA human language. ?? (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idAppointment.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. 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 in formation is added later. Narrative Constraints
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idAppointment.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Resource Mappings
| |
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. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
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). Identifier Constraints
|
status | Σ ?! | 1..1 | codeBinding | Element idAppointment.status Pospuesta | Pendiente | Agendada | Paciente ha llegado | Completada | Cancelada | Paciente no ha llegado | Anotada por error DefinitionThe 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. SCH-25. 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. code BindingThe free/busy status of an appointment. ?? (required)Constraints
|
serviceCategory | Σ | 0..1 | CodeableConcept | Element idAppointment.serviceCategory A broad categorisation of the service that is to be performed during this appointment DefinitionAIS.11.Conjunto de servicios que se realizarán durante esta cita. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept Binding?? (example) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.serviceCategory.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.serviceCategory.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. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idAppointment.serviceCategory.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.serviceCategory.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.serviceCategory.coding.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. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 0..1 | uriFixed Value | Element idAppointment.serviceCategory.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
http://hl7.org/fhir/service-category
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idAppointment.serviceCategory.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idAppointment.serviceCategory.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAppointment.serviceCategory.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idAppointment.serviceCategory.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idAppointment.serviceCategory.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
serviceType | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAppointment.serviceType The specific service that is to be performed during this appointment DefinitionThe specific service that is to be performed during this appointment. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept Binding?? (example) Constraints
|
specialty | Σ | 0..* | CodeableConceptBinding | Element idAppointment.specialty The specialty of a practitioner that would be required to perform the service requested in this appointment DefinitionDepartamento / Servicio / Especialidad citado/a Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept Binding?? (preferred) Constraints
|
appointmentType | Σ | 0..1 | CodeableConceptBinding | Element idAppointment.appointmentType CHECKUP|EMERGENCY|FOLLOWUP|ROUTINE|WALKIN DefinitionARQ-7. Tipo de cita. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept Binding?? (preferred) Constraints
|
reason | Σ | 0..* | CodeableConceptBinding | Element idAppointment.reason Justificación clínica DefinitionThe reason that this appointment is being scheduled. This is more clinical than administrative. Include codes from http://snomed.info/sct where concept is-a 404684003 (Clinical finding) Include codes from http://snomed.info/sct where concept is-a 71388002 (Procedure) Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept BindingThe Reason for the appointment to take place. ?? (preferred)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.reason.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.reason.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. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idAppointment.reason.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.reason.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.reason.coding.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. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 0..1 | uriFixed Value | Element idAppointment.reason.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
http://snomed.info/sct
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idAppointment.reason.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 0..1 | code | Element idAppointment.reason.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. AIS-3, SCH-7. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAppointment.reason.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idAppointment.reason.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idAppointment.reason.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
indication | I | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Condition | http://hl7.org/fhir/StructureDefinition/Procedure) | There are no (further) constraints on this element Element idAppointment.indication Reason the appointment is to takes place (resource) DefinitionReason 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/Condition | http://hl7.org/fhir/StructureDefinition/Procedure) Constraints
|
priority | 0..1 | unsignedInt | Element idAppointment.priority Used to make informed decisions if needing to re-prioritize DefinitionSCH.11 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). ARQ-12, SCH-11.6 / TQ1-9. 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. unsignedInt Constraints
| |
description | 0..1 | string | There are no (further) constraints on this element Element idAppointment.description Shown on a subject line in a meeting request, or appointment list DefinitionThe 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. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
supportingInformation | I | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Resource) | There are no (further) constraints on this element Element idAppointment.supportingInformation Additional information to support the appointment DefinitionAdditional information to support the appointment provided when making the appointment. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/Resource) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.supportingInformation.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.supportingInformation.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. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 0..1 | string | Element idAppointment.supportingInformation.reference Literal reference, Relative, internal or absolute URL DefinitionNTE.4 A 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. string Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idAppointment.supportingInformation.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. Identifier Constraints
|
display | Σ | 0..1 | string | Element idAppointment.supportingInformation.display Text alternative for the resource DefinitionNTE.3. Plain 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. string Constraints
|
start | Σ | 0..1 | instant | Element idAppointment.start When appointment is to take place DefinitionDate/Time that the appointment is to take place. ARQ-11.1, SCH-11.4 / TQ1-7. Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required instant Constraints
|
end | Σ | 0..1 | instant | Element idAppointment.end When appointment is to conclude DefinitionDate/Time that the appointment is to conclude. SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9 Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required instant Constraints
|
minutesDuration | 0..1 | positiveInt | There are no (further) constraints on this element Element idAppointment.minutesDuration Can be less than start/end (e.g. estimate) DefinitionNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request). 32 bit number; for values larger than this, use decimal positiveInt Constraints
| |
slot | I | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Slot) | There are no (further) constraints on this element Element idAppointment.slot The slots that this appointment is filling DefinitionThe slots from the participants' schedules that will be filled by the appointment. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/Slot) Constraints
|
created | 0..1 | dateTime | There are no (further) constraints on this element Element idAppointment.created The date that this appointment was initially created DefinitionThe 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. 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. dateTime Constraints
| |
comment | 0..0 | string | Element idAppointment.comment Additional comments DefinitionAdditional comments about the appointment. NTE-3. 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. string Constraints
| |
incomingReferral | I | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/ReferralRequest) | There are no (further) constraints on this element Element idAppointment.incomingReferral The ReferralRequest provided as information to allocate to the Encounter DefinitionThe referral request this appointment is allocated to assess (incoming referral). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/ReferralRequest) Constraints
|
participant | I | 1..* | BackboneElement | Element idAppointment.participant Participantes envueltos en la cita DefinitionListado de participantes envueltos en la cita. PID, AIP, AIG, AIL BackboneElement Sliced:Unordered, Open, by actor.reference(Value) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
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. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.modifierExtension Extensions that cannot be ignored 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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. Extension Constraints
|
type | Σ | 0..* | CodeableConceptBinding | Element idAppointment.participant.type Role of participant in the appointment DefinitionRole of participant in the appointment. AIP-4, AIG-4. 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. CodeableConcept BindingRole of participant in encounter. ?? (extensible)Constraints
|
actor | Σ I | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/RelatedPerson | http://hl7.org/fhir/StructureDefinition/Device | http://hl7.org/fhir/StructureDefinition/HealthcareService | http://hl7.org/fhir/StructureDefinition/Location) | Element idAppointment.participant.actor Person, Location/HealthcareService or Device DefinitionA Person, Location/HealthcareService or Device that is participating in the appointment. PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/RelatedPerson | http://hl7.org/fhir/StructureDefinition/Device | http://hl7.org/fhir/StructureDefinition/HealthcareService | http://hl7.org/fhir/StructureDefinition/Location) Constraints
|
required | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.required required | optional | information-only DefinitionIs this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. Note that FHIR strings may not exceed 1MB in size code BindingIs the Participant required to attend the appointment. ?? (required)Constraints
|
status | 1..1 | codeBinding | Element idAppointment.participant.status accepted | declined | tentative | needs-action DefinitionParticipation status of the actor. AIP-12, AIG-14. Note that FHIR strings may not exceed 1MB in size code BindingThe Participation status of an appointment. ?? (required)Constraints
| |
requestedPeriod | I | 0..* | Period | Element idAppointment.requestedPeriod Potential date/time interval(s) requested to allocate the appointment within DefinitionA set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. ARQ-11. This does not introduce a capacity for recurring appointments. Period Constraints
|
Elemento
Nombre Alternativo: Consulta externa, revisión, visita, programación.
Descripción del Arquetipo: Se entiende por cita una programación de una visita de un paciente a consultas externas en los centros sanitarios de la comunidad autonoma de Baleares.
Palabras Clave: Cita, programación, visita.
Objetivo: Registrar los eventos que pueden ser notificados a la Base de datos asistencial corporativa (BDAC) en relacion a las citas de consultas externas de un paciente y la información que contiene el objejo FHIR appointment.
Uso: Se propone su uso para proporcionar información de la cita (creación, modificación, reprogramación, cancelación, finalización) en consultas externas, su identificación dentro del sistema información sanitaria: paciente, servicio, centro de salud y resto de participantes .
Este arquetipo ha sido diseñado para almacenar toda la información relativa a una cita y su relacion con el sistema de salud. El contenido de este arquetipo es el resultado de una evaluación de la Comisión de Historia de Salud de IB-Salut de los arquetipos de openEHR, HL7 FHIR, y la experiencia previa con las aplicaciones actuales utilizadas en cada gerencia.
Mensajeria HL7
Se registran siete eventos que activan y utilizan este arquetipo y el cual sera empleado atendiendo a la información que se reciba de los sistema origen en la mensajeria HL7 definida para este tipo de eventos:
• Notificar nueva cita (SIU^S12)
• Notificar reprogramación de cita (SIU^S13)
• Notificar modificación de cita (SIU^S14)
• Notificar cancelación de cita (SIU^S15)
• Notificar no asistencia a una cita (SIU^S26)
• Notificar finalización de la cita (ADT^A03)
Uso Incorrecto: No debe ser utilizado para registrar cualquier otra información que no sea relativa a la cita como tal. Aquella información no relativa a la razón clinica, observaciones y participantes de la cita debe ser tratada y documentada con otros arquetipos acordes a dicha información.
Atributos del arquetipo
Nombre/Atributo | FHIR | Campo HL7 | Descripción / Comentario |
---|---|---|---|
ID de la cita | Appointment.Identifier.value | SCH.2 | Identificador de la cita que nos llega del sistema origen. Podemos completar esta información con la organización, el sistema que ha enviado el ID... |
Estado de la cita | Appointment.status | SCH.25 | El estado en el que se encuentra la cita. Los valores propuestos son: Pospuesta | Pendiente | Agendada | Paciente ha llegado | Completada | Cancelada | Paciente no ha llegado | Anotada por error. El objeto FHIR define el SCH-25 para coger esta informacion, pero aquí no nos lo mandan. |
Tipo de prestación | Appointment.serviceCategory | AIS.2 y AIS3 | Tipo de servicio/s que se van a realizar en la cita. Elemento codificado que debe ser definido. |
Prestacion | Appointment.serviceType | AIS3 | Prestacion citada |
Especialidad de la prestación | Appointment.specialty | AIS.11 | Especialidad de la cita |
Tipo de cita | Appointment.appointmentType | ARQ.7 | Se puede usar tambien para determinar la prioridad de la cita (urgente, normal, seguimiento...) No se envia. Se debe determinar que segmento y campo va a tener este dato |
Prioridad | appointment.priority | SCH.11 | Se utiliza para marcar si la cita es prioritaria o no.No se envia actualmente en el mensaje HL7 |
Notas | appointment.supportingInformation | NTE | Información adifional a tener en cuenta en la cita. Esta información vendra codificada atendiendo al recurso al que se hace referencia. |
Notas (Codigo) | appointment.supportinginformation.reference | NTE.4 | Identificador para el tipo de comentario, según la siguiente relación: P: Instrucción del paciente AI: Instrucción auxiliar GI: Instrucción general RE: Observación |
Notas (texto) | appointment.supportinginformation.display | NTE.3 | Texto libre con las notas, comentario relativo al proceso programado, instrucciones para el paciente, medicacion previa necesaria u otra informacion relevante. |
Justificación clínica | Appointment.Reason | ?? | Motivo por el cual se ha citado |
Fecha/hora de comienzo | Appointment.start | Fecha/Hora de comienzo de la cita | |
Fecha/hora de fin | Appointment.end | Fecha/Hora de fin de la cita | |
Duración | Appointment.minutesDuration | Campo calculado con la duración de la cita | |
Fecha y hora de la cita | Appointment.slot.start / appointment.RequestedPeriod.start | AIS.4 | Fecha y hora de la cita. |
Fecha y hora de creación | Appointment.created | MSH.7.1 | Fecha y hora en que fue creada la cita (tomamos el valor de la fecha y hora del segmento MSH ya que no viene dado en la definición del mensaje de cita) |
Paciente | appointment.particiant | PID | información relacionada con el paciente |
Médico asociado a la cita | appointment.particiant | PV1.7 | información relacionada con el médico que va a atender la cita. |
lugar de la cita | appointment.particiant | PV1.3 | Información relacionada con el lugar de la cita. PV1 (3.1 Unidad o Departamento, 3.2 Habitación, 3.3. Cama, 3.4.1 Organización, 3.6 Tipo Localización, 3.7 Edificio, 3.8 Planta). Generar un Location con la estructura: Edificio, Planta, Habitación, Cama. |
Estado del participante | Appointment.participant.status | xxx | Estado del participante. Es obligatorio y debe estar codificado (Aceptado, Denegado, Tentativa, Necesita Acción) |
Participantes
El elemento partipante va a ser utilizado para almacenar la información relacionada al paciente, medico y lugar de la cita. Sera por tanto de caracter obligatorio y de cardinalidad 3..n ya que como mínimo almacenaremos la información comentada anteriormente.
El elemento discrimiador sera el valor almacenado dentro del campo Appointment.participant.type. Dependiendo de que se este almacenando el actor será un elemento u otro atendiendo a este tipo.
Dudas a revisar:
• Status: El objeto FHIR define el SCH-25 para coger esta informacion, pero aquí no nos lo mandan.
• Appointment type. Según FHIR el tipo de cita vendra en el campo 7 del segmento ARQ, pero creo que es mas conveniente el campo 8. De cualquier forma no se envía el segmento ARQ.
• Participant.type: se obtiene del segmento AIP o AIG que no estan incluidos en esta definición.
• Participant.Actor. En caso de ser algo diferente al paciente no sabemos de donde cogerlo. Según la definición del objeto FHIR esta información debe cogerse de los campos: PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3.
• Participant.Status: Igual que Participant.type: AIP-12, AIG-14.