Guía de Implementación Core de Costa Rica
0.1.0 - ci-build
Guía de Implementación Core de Costa Rica - Versión en desarrollo (v0.1.0): borrador de trabajo de la Iniciativa HL7® Costa Rica, que puede cambiar sin aviso.
| Estado de las normas de la página: Draft |
Definiciones del cr-list-lote-envio perfil de los recursos.
Las indicaciones para interpretar el contenido de esta tabla estánaquí
| 0. List | |
| Definición | Lote con que un sistema envía uno o varios documentos al HIE, adaptado del SubmissionSet de IHE MHD: quién lo envía, de qué paciente, cuándo y qué referencias incluye. A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc. |
| Resumen | Lote de envío: las referencias que un sistema envía juntas al HIEA list is a curated collection of resources |
| Control | 0..* |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Nombres alternativos | Collection, WorkingList, Organizer |
| Invariantes | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-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()) lst-1: A list can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty()) |
| 2. List.implicitRules | |
| Definición | 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. |
| Resumen | A set of rules under which this content was created |
| Comentarios | 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 its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Tipo | uri |
| Es modificador | true porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | true |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. List.contained | |
| Definición | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Resumen | Contained, inline Resources |
| Comentarios | 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. |
| Control | 0..* Este elemento está afectado por las siguientes invariantes: dom-2, dom-4, dom-3, dom-5 |
| Tipo | Resource |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Nombres alternativos | inline resources, anonymous resources, contained resources |
| 6. List.modifierExtension | |
| Definición | 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 managable, 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). |
| Resumen | Extensions that cannot be ignored |
| Comentarios | 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. |
| Control | 0..* |
| Tipo | Extension |
| Es modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Resumen | 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. |
| Nombres 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()) |
| 8. List.identifier | |
| Definición | Identifier for the List assigned for business purposes outside the context of FHIR. |
| Resumen | Identificador único del lote (urn:uuid)Business identifier |
| Nota | This is a business identifier, not a resource identifier (see discusión) |
| Control | 10..1* |
| Tipo | Identifier |
| Es modificador | false |
| Must Support | true |
| Resumen | false |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. List.identifier.use | |
| Definición | The purpose of this identifier. |
| Resumen | usual | official | temp | secondary | old (If known) |
| Comentarios | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Vinculación | Los códigos DEBEN tomarse de IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Tipo | code |
| Es modificador | true porque This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Resumen | true |
| Requisitos | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. List.identifier.system | |
| Definición | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Resumen | urn:ietf:rfc:3986 (valor fijo)The namespace for the identifier value |
| Comentarios | Identifier.system is always case sensitive. |
| Control | 10..1 |
| Tipo | uri |
| Es modificador | false |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | true |
| Resumen | true |
| Requisitos | 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. |
| Pattern Value | urn:ietf:rfc:3986 |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. List.identifier.value | |
| Definición | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Resumen | urn:uuid: seguido de un UUIDThe value that is unique |
| Comentarios | 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 10..1 Este elemento está afectado por las siguientes invariantes: ident-1 |
| Tipo | string |
| Es modificador | false |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | true |
| Resumen | true |
| Example | General: 123456 |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. List.status | |
| Definición | Indicates the current state of this list. |
| Resumen | current (valor fijo)current | retired | entered-in-error |
| Comentarios | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| Control | 1..1 |
| Vinculación | Los códigos DEBEN tomarse de ListStatushttp://hl7.org/fhir/ValueSet/list-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/list-status|5.0.0)The current state of the list. |
| Tipo | code |
| Es modificador | true porque This element is labeled 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 puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | true |
| Pattern Value | current |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. List.mode | |
| Definición | How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
| Resumen | working (valor fijo)working | snapshot | changes |
| Comentarios | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. |
| Control | 1..1 |
| Vinculación | Los códigos DEBEN tomarse de ListModehttp://hl7.org/fhir/ValueSet/list-mode|5.0.0 (required to http://hl7.org/fhir/ValueSet/list-mode|5.0.0)The processing mode that applies to this list. |
| Tipo | code |
| Es modificador | true porque If set to "changes", the list is considered incomplete, while the other two codes indicate the list is complete, which changes the understanding of the elements listed |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | true |
| Requisitos | Lists are used in various ways, and it must be known in what way it is safe to use them. |
| Pattern Value | working |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. List.code | |
| Definición | This code defines the purpose of the list - why it was created. |
| Resumen | submissionset de IHE MHD (valor fijo)What the purpose of this list is |
| Comentarios | If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code. |
| Control | 10..1 |
| Vinculación | Para códigos de ejemplo, vea ExampleUseCodesForListhttp://hl7.org/fhir/ValueSet/list-example-codes|5.0.0 (example to http://hl7.org/fhir/ValueSet/list-example-codes|5.0.0)What the purpose of a list is. |
| Tipo | CodeableConcept |
| Es modificador | false |
| Must Support | true |
| Resumen | true |
| Requisitos | Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. |
| Pattern Value | { |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. List.subject | |
| Definición | The common subject(s) (or patient(s)) of the resources that are in the list if there is one (or a set of subjects). |
| Resumen | Paciente de los documentos del loteIf all resources have the same subject(s) |
| Comentarios | Some purely arbitrary lists do not have a common subject, so this is optional. Lists having multiple subjects may raise challenges for systems that base access control or other security considerations on linkages to 'subject'. E.g. if a List is associated with multiple Patient subjects, then it would be nominally part of multiple patient compartments, which might drive access rights. |
| Control | 10..1* |
| Tipo | Reference(Paciente, Resource) |
| Es modificador | false |
| Must Support | true |
| Resumen | true |
| Requisitos | The primary purpose of listing the subject explicitly is to help with finding the right list. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. List.date | |
| Definición | Date list was last reviewed/revised and determined to be 'current'. |
| Resumen | Momento del envíoWhen the list was prepared |
| Comentarios | The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs. |
| Control | 10..1 |
| Tipo | dateTime |
| Es modificador | false |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | true |
| Resumen | true |
| Requisitos | Identifies how current the list is which affects relevance. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. List.source | |
| Definición | The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. |
| Resumen | Organización que envía el loteWho and/or what defined the list contents (aka Author) |
| Comentarios | The primary source is the entity that made the decisions what items are in the list. This may be software or user. |
| Control | 10..1 |
| Tipo | Reference(Organización, Practitioner, PractitionerRole, Patient, Device, Organization, RelatedPerson, CareTeam) |
| Es modificador | false |
| Must Support | true |
| Resumen | true |
| Requisitos | Allows follow-up as well as context. |
| Nombres alternativos | Author |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. List.entry | |
| Definición | Entries in this list. |
| Resumen | Las referencias del loteEntries in the list |
| Comentarios | If there are no entries in the list, an emptyReason SHOULD be provided. |
| Control | 10..* Este elemento está afectado por las siguientes invariantes: lst-1 |
| Tipo | BackboneElement |
| Es modificador | false |
| Must Support | true |
| Resumen | false |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. List.entry.modifierExtension | |
| Definición | 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 managable, 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). |
| Resumen | Extensions that cannot be ignored even if unrecognized |
| Comentarios | 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. |
| Control | 0..* |
| Tipo | Extension |
| Es modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Resumen | 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. |
| Nombres 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()) |
| 32. List.entry.deleted | |
| Definición | True if this item is marked as deleted in the list. |
| Resumen | If this item is actually marked as deleted |
| Comentarios | If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. A deleted entry should be displayed in narrative as deleted. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list. |
| Control | 0..1 |
| Tipo | boolean |
| Es modificador | true porque If deleted is true, then the item included in the list isn't actually part of the list anymore |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | false |
| Requisitos | The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted". |
| Meaning if Missing | List items are generally only treated as deleted when this element explicitly carries a value of true. Systems SHOULD always populate this value when mode is 'changes' |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. List.entry.item | |
| Definición | A reference to the actual resource from which data was derived. |
| Resumen | Referencia a documentoActual entry |
| Control | 1..1 |
| Tipo | Reference(Referencia a documento, Resource) |
| Es modificador | false |
| Must Support | true |
| Resumen | false |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Las indicaciones para interpretar el contenido de esta tabla estánaquí
| 0. List | |
| Definición | Lote con que un sistema envía uno o varios documentos al HIE, adaptado del SubmissionSet de IHE MHD: quién lo envía, de qué paciente, cuándo y qué referencias incluye. |
| Resumen | Lote de envío: las referencias que un sistema envía juntas al HIE |
| 2. List.identifier | |
| Resumen | Identificador único del lote (urn:uuid) |
| Nota | This is a business identifier, not a resource identifier (see discusión) |
| Control | 1..1 |
| Must Support | true |
| 4. List.identifier.system | |
| Resumen | urn:ietf:rfc:3986 (valor fijo) |
| Control | 1..? |
| Must Support | true |
| Pattern Value | urn:ietf:rfc:3986 |
| 6. List.identifier.value | |
| Resumen | urn:uuid: seguido de un UUID |
| Control | 1..? |
| Must Support | true |
| 8. List.status | |
| Resumen | current (valor fijo) |
| Pattern Value | current |
| 10. List.mode | |
| Resumen | working (valor fijo) |
| Pattern Value | working |
| 12. List.code | |
| Resumen | submissionset de IHE MHD (valor fijo) |
| Control | 1..? |
| Must Support | true |
| Pattern Value | { |
| 14. List.subject | |
| Resumen | Paciente de los documentos del lote |
| Control | 1..1 |
| Tipo | Reference(Paciente) |
| Must Support | true |
| 16. List.date | |
| Resumen | Momento del envío |
| Control | 1..? |
| Must Support | true |
| 18. List.source | |
| Resumen | Organización que envía el lote |
| Control | 1..? |
| Tipo | Reference(Organización) |
| Must Support | true |
| 20. List.entry | |
| Resumen | Las referencias del lote |
| Control | 1..? |
| Must Support | true |
| 22. List.entry.item | |
| Resumen | Referencia a documento |
| Tipo | Reference(Referencia a documento) |
| Must Support | true |
Las indicaciones para interpretar el contenido de esta tabla estánaquí
| 0. List | |
| Definición | Lote con que un sistema envía uno o varios documentos al HIE, adaptado del SubmissionSet de IHE MHD: quién lo envía, de qué paciente, cuándo y qué referencias incluye. |
| Resumen | Lote de envío: las referencias que un sistema envía juntas al HIE |
| Control | 0..* |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Nombres alternativos | Collection, WorkingList, Organizer |
| Invariantes | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-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())lst-1: A list can only have an emptyReason if it is empty ( emptyReason.empty() or entry.empty()) |
| 2. List.id | |
| Definición | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Resumen | Logical id of this artifact |
| Comentarios | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Tipo | id |
| Es modificador | false |
| Must Support | false |
| Resumen | true |
| 4. List.meta | |
| Definición | 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. |
| Resumen | Metadata about the resource |
| Control | 0..1 |
| Tipo | Meta |
| Es modificador | false |
| Must Support | false |
| Resumen | true |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. List.implicitRules | |
| Definición | 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. |
| Resumen | A set of rules under which this content was created |
| Comentarios | 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 its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Tipo | uri |
| Es modificador | true porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | true |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. List.language | |
| Definición | The base language in which the resource is written. |
| Resumen | Language of the resource content |
| Comentarios | 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). |
| Control | 0..1 |
| Vinculación | Los códigos DEBEN tomarse de AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Tipo | code |
| Es modificador | false |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | false |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. List.text | |
| Definición | 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. |
| Resumen | Text summary of the resource, for human interpretation |
| Comentarios | Contained resources do not have a 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. |
| Control | 0..1 Este elemento está afectado por las siguientes invariantes: dom-6 |
| Tipo | Narrative |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Nombres alternativos | narrative, html, xhtml, display |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. List.contained | |
| Definición | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Resumen | Contained, inline Resources |
| Comentarios | 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. |
| Control | 0..* Este elemento está afectado por las siguientes invariantes: dom-2, dom-4, dom-3, dom-5 |
| Tipo | Resource |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Nombres alternativos | inline resources, anonymous resources, contained resources |
| 14. List.extension | |
| Definición | 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 managable, 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. |
| Resumen | Additional content defined by implementations |
| Comentarios | 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. |
| Control | 0..* |
| Tipo | Extension |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Nombres 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. List.modifierExtension | |
| Definición | 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 managable, 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). |
| Resumen | Extensions that cannot be ignored |
| Comentarios | 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. |
| Control | 0..* |
| Tipo | Extension |
| Es modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Resumen | 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. |
| Nombres 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. List.identifier | |
| Definición | Identifier for the List assigned for business purposes outside the context of FHIR. |
| Resumen | Identificador único del lote (urn:uuid) |
| Nota | This is a business identifier, not a resource identifier (see discusión) |
| Control | 1..1 |
| Tipo | Identifier |
| Es modificador | false |
| Must Support | true |
| Resumen | false |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. List.identifier.id | |
| Definición | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Resumen | Unique id for inter-element referencing |
| Control | 0..1 Este elemento está afectado por las siguientes invariantes: ele-1 |
| Tipo | id |
| Es modificador | false |
| Formato XML | En el formato XML, esta propiedad se representa como un atributo. |
| Resumen | false |
| 22. List.identifier.extension | |
| Definición | 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 managable, 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. |
| Resumen | Additional content defined by implementations |
| Comentarios | 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. |
| Control | 0..* |
| Tipo | Extension |
| Es modificador | false |
| Resumen | false |
| Nombres 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()) |
| Slicing | Este elemento introduce un conjunto de slices en List.identifier.extension. Los slices sonSin orden y Open, y se distinguen con los siguientes discriminadores: |
| 24. List.identifier.use | |
| Definición | The purpose of this identifier. |
| Resumen | usual | official | temp | secondary | old (If known) |
| Comentarios | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Vinculación | Los códigos DEBEN tomarse de IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Tipo | code |
| Es modificador | true porque This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Resumen | true |
| Requisitos | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. List.identifier.type | |
| Definición | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Resumen | Description of identifier |
| Comentarios | 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. |
| Control | 0..1 |
| Vinculación | Salvo que no sean adecuados, estos códigos DEBEN tomarse de IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Tipo | CodeableConcept |
| Es modificador | false |
| Resumen | true |
| Requisitos | Allows users to make use of identifiers when the identifier system is not known. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. List.identifier.system | |
| Definición | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Resumen | urn:ietf:rfc:3986 (valor fijo) |
| Comentarios | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Tipo | uri |
| Es modificador | false |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | true |
| Resumen | true |
| Requisitos | 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. |
| Pattern Value | urn:ietf:rfc:3986 |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. List.identifier.value | |
| Definición | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Resumen | urn:uuid: seguido de un UUID |
| Comentarios | 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 1..1 Este elemento está afectado por las siguientes invariantes: ident-1 |
| Tipo | string |
| Es modificador | false |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | true |
| Resumen | true |
| Example | General: 123456 |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. List.identifier.period | |
| Definición | Time period during which identifier is/was valid for use. |
| Resumen | Time period when id is/was valid for use |
| Control | 0..1 |
| Tipo | Period |
| Es modificador | false |
| Resumen | true |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. List.identifier.assigner | |
| Definición | Organization that issued/manages the identifier. |
| Resumen | Organization that issued id (may be just text) |
| Comentarios | 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. |
| Control | 0..1 |
| Tipo | Reference(Organization) |
| Es modificador | false |
| Resumen | true |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. List.status | |
| Definición | Indicates the current state of this list. |
| Resumen | current (valor fijo) |
| Comentarios | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| Control | 1..1 |
| Vinculación | Los códigos DEBEN tomarse de ListStatus (required to http://hl7.org/fhir/ValueSet/list-status|5.0.0)The current state of the list. |
| Tipo | code |
| Es modificador | true porque This element is labeled 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 puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | true |
| Pattern Value | current |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. List.mode | |
| Definición | How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
| Resumen | working (valor fijo) |
| Comentarios | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. |
| Control | 1..1 |
| Vinculación | Los códigos DEBEN tomarse de ListMode (required to http://hl7.org/fhir/ValueSet/list-mode|5.0.0)The processing mode that applies to this list. |
| Tipo | code |
| Es modificador | true porque If set to "changes", the list is considered incomplete, while the other two codes indicate the list is complete, which changes the understanding of the elements listed |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | true |
| Requisitos | Lists are used in various ways, and it must be known in what way it is safe to use them. |
| Pattern Value | working |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. List.title | |
| Definición | A label for the list assigned by the author. |
| Resumen | Descriptive name for the list |
| Control | 0..1 |
| Tipo | string |
| Es modificador | false |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | true |
| Requisitos | Allows customization beyond just the code identifying the kind of list. |
| Example | General: Dr. Jane's Patients |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. List.code | |
| Definición | This code defines the purpose of the list - why it was created. |
| Resumen | submissionset de IHE MHD (valor fijo) |
| Comentarios | If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code. |
| Control | 1..1 |
| Vinculación | Para códigos de ejemplo, vea ExampleUseCodesForList (example to http://hl7.org/fhir/ValueSet/list-example-codes|5.0.0)What the purpose of a list is. |
| Tipo | CodeableConcept |
| Es modificador | false |
| Must Support | true |
| Resumen | true |
| Requisitos | Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. |
| Pattern Value | { |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. List.subject | |
| Definición | The common subject(s) (or patient(s)) of the resources that are in the list if there is one (or a set of subjects). |
| Resumen | Paciente de los documentos del lote |
| Comentarios | Some purely arbitrary lists do not have a common subject, so this is optional. Lists having multiple subjects may raise challenges for systems that base access control or other security considerations on linkages to 'subject'. E.g. if a List is associated with multiple Patient subjects, then it would be nominally part of multiple patient compartments, which might drive access rights. |
| Control | 1..1 |
| Tipo | Reference(Paciente) |
| Es modificador | false |
| Must Support | true |
| Resumen | true |
| Requisitos | The primary purpose of listing the subject explicitly is to help with finding the right list. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. List.encounter | |
| Definición | The encounter that is the context in which this list was created. |
| Resumen | Context in which list created |
| Control | 0..1 |
| Tipo | Reference(Encounter) |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. List.date | |
| Definición | Date list was last reviewed/revised and determined to be 'current'. |
| Resumen | Momento del envío |
| Comentarios | The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs. |
| Control | 1..1 |
| Tipo | dateTime |
| Es modificador | false |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | true |
| Resumen | true |
| Requisitos | Identifies how current the list is which affects relevance. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 50. List.source | |
| Definición | The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. |
| Resumen | Organización que envía el lote |
| Comentarios | The primary source is the entity that made the decisions what items are in the list. This may be software or user. |
| Control | 1..1 |
| Tipo | Reference(Organización) |
| Es modificador | false |
| Must Support | true |
| Resumen | true |
| Requisitos | Allows follow-up as well as context. |
| Nombres alternativos | Author |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. List.orderedBy | |
| Definición | What order applies to the items in the list. |
| Resumen | What order the list has |
| Comentarios | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. |
| Control | 0..1 |
| Vinculación | Los códigos DEBERÍAN tomarse de ListOrderCodes (preferred to http://hl7.org/fhir/ValueSet/list-order|5.0.0)What order applies to the items in a list. |
| Tipo | CodeableConcept |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Requisitos | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. List.note | |
| Definición | Comments that apply to the overall list. |
| Resumen | Comments about the list |
| Control | 0..* |
| Tipo | Annotation |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. List.entry | |
| Definición | Entries in this list. |
| Resumen | Las referencias del lote |
| Comentarios | If there are no entries in the list, an emptyReason SHOULD be provided. |
| Control | 1..* Este elemento está afectado por las siguientes invariantes: lst-1 |
| Tipo | BackboneElement |
| Es modificador | false |
| Must Support | true |
| Resumen | false |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. List.entry.id | |
| Definición | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Resumen | Unique id for inter-element referencing |
| Control | 0..1 Este elemento está afectado por las siguientes invariantes: ele-1 |
| Tipo | string |
| Es modificador | false |
| Formato XML | En el formato XML, esta propiedad se representa como un atributo. |
| Resumen | false |
| 60. List.entry.extension | |
| Definición | 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 managable, 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. |
| Resumen | Additional content defined by implementations |
| Comentarios | 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. |
| Control | 0..* |
| Tipo | Extension |
| Es modificador | false |
| Resumen | false |
| Nombres 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()) |
| 62. List.entry.modifierExtension | |
| Definición | 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 managable, 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). |
| Resumen | Extensions that cannot be ignored even if unrecognized |
| Comentarios | 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. |
| Control | 0..* |
| Tipo | Extension |
| Es modificador | true porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Resumen | 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. |
| Nombres 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()) |
| 64. List.entry.flag | |
| Definición | The flag allows the system constructing the list to indicate the role and significance of the item in the list. |
| Resumen | Status/Workflow information about this item |
| Comentarios | The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true |
| Control | 0..1 |
| Vinculación | Para códigos de ejemplo, vea PatientMedicineChangeTypes (example to http://hl7.org/fhir/ValueSet/list-item-flag|5.0.0)Codes that provide further information about the reason and meaning of the item in the list. |
| Tipo | CodeableConcept |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Requisitos | This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. List.entry.deleted | |
| Definición | True if this item is marked as deleted in the list. |
| Resumen | If this item is actually marked as deleted |
| Comentarios | If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. A deleted entry should be displayed in narrative as deleted. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list. |
| Control | 0..1 |
| Tipo | boolean |
| Es modificador | true porque If deleted is true, then the item included in the list isn't actually part of the list anymore |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | false |
| Requisitos | The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted". |
| Meaning if Missing | List items are generally only treated as deleted when this element explicitly carries a value of true. Systems SHOULD always populate this value when mode is 'changes' |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 68. List.entry.date | |
| Definición | When this item was added to the list. |
| Resumen | When item added to list |
| Control | 0..1 |
| Tipo | dateTime |
| Es modificador | false |
| Valor primitivo | Este elemento primitivo puede estar presente, ausente o reemplazado por una extensión |
| Must Support | false |
| Resumen | false |
| Requisitos | The date may be significant for understanding the meaning of items in a working list. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. List.entry.item | |
| Definición | A reference to the actual resource from which data was derived. |
| Resumen | Referencia a documento |
| Control | 1..1 |
| Tipo | Reference(Referencia a documento) |
| Es modificador | false |
| Must Support | true |
| Resumen | false |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. List.emptyReason | |
| Definición | If the list is empty, why the list is empty. |
| Resumen | Why list is empty |
| Comentarios | The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. |
| Control | 0..1 Este elemento está afectado por las siguientes invariantes: lst-1 |
| Vinculación | Los códigos DEBERÍAN tomarse de ListEmptyReasons (preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|5.0.0)If a list is empty, why it is empty. |
| Tipo | CodeableConcept |
| Es modificador | false |
| Must Support | false |
| Resumen | false |
| Requisitos | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
| Invariantes | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |