Guia de Implementação da SES GO - Segurança
0.1.0 - draft Brazil flag

Guia de Implementação da SES GO - Segurança - Downloaded Version 0.1.0 See the Directory of published versions

Perfil: InformacaoAssinada - Descrição detalhada

Draft as of 2025-12-03

Definições para informacao-assinada perfil.

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

0. DocumentReference
CurtoConteúdo a ser assinado (externo)
2. DocumentReference.content
4. DocumentReference.content.attachment
CurtoDeve incluir SHA-256 do conteúdo do anexo
TipoAttachment(Anexo para assinar)

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

0. DocumentReference
Definição

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

CurtoConteúdo a ser assinado (externo)A reference to a document
Comentários

Usually, this is used for documents other than those defined by FHIR.

Controlo0..*
É modificadorfalse
Resumofalse
Invariantesdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. DocumentReference.implicitRules
Definição

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.

CurtoA set of rules under which this content was created
Comentários

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Controlo0..1
Tipouri
É modificadortrue porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. DocumentReference.modifierExtension
Definição

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CurtoExtensions that cannot be ignored
Comentários

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Controlo0..*
TipoExtension
É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Resumofalse
Requisitos

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Nomes alternativosextensions, user content
Invariantesele-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())
6. DocumentReference.status
Definição

The status of this document reference.

Curtocurrent | superseded | entered-in-error
Comentários

This is the status of the DocumentReference object, which might be independent from the docStatus element.

This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.

Controlo1..1
VínculoOs códigos DEVERÃO ser retirados de DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1)

The status of the document reference.

Tipocode
É modificadortrue porque This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. DocumentReference.content
Definição

The document and format referenced. There may be multiple content element repetitions, each with a different format.

CurtoDocument referenced
Controlo1..*
TipoBackboneElement
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. DocumentReference.content.modifierExtension
Definição

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CurtoExtensions that cannot be ignored even if unrecognized
Comentários

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Controlo0..*
TipoExtension
É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumotrue
Requisitos

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Nomes alternativosextensions, user content, modifiers
Invariantesele-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())
12. DocumentReference.content.attachment
Definição

The document or URL of the document along with critical metadata to prove content has integrity.

CurtoDeve incluir SHA-256 do conteúdo do anexoWhere to access the document
Controlo1..1
TipoAttachment(Anexo para assinar)
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. DocumentReference
Definição

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

CurtoConteúdo a ser assinado (externo)
Comentários

Usually, this is used for documents other than those defined by FHIR.

Controlo0..*
É modificadorfalse
Resumofalse
Invariantesdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. DocumentReference.id
Definição

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

CurtoLogical id of this artifact
Comentários

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Controlo0..1
Tipoid
É modificadorfalse
Resumotrue
4. DocumentReference.meta
Definição

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.

CurtoMetadata about the resource
Controlo0..1
TipoMeta
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. DocumentReference.implicitRules
Definição

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.

CurtoA set of rules under which this content was created
Comentários

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Controlo0..1
Tipouri
É modificadortrue porque This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. DocumentReference.language
Definição

The base language in which the resource is written.

CurtoLanguage of the resource content
Comentários

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Controlo0..1
VínculoOs códigos DEVERÃO ser retirados de CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Vínculos adicionaisObjetivo
AllLanguagesVínculo máximo
Tipocode
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. DocumentReference.text
Definição

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.

CurtoText summary of the resource, for human interpretation
Comentários

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Controlo0..1
TipoNarrative
É modificadorfalse
Resumofalse
Nomes alternativosnarrative, html, xhtml, display
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. DocumentReference.contained
Definição

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

CurtoContained, inline Resources
Comentários

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Controlo0..*
TipoResource
É modificadorfalse
Resumofalse
Nomes alternativosinline resources, anonymous resources, contained resources
14. DocumentReference.extension
Definição

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CurtoAdditional content defined by implementations
Comentários

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Controlo0..*
TipoExtension
É modificadorfalse
Resumofalse
Nomes alternativosextensions, user content
Invariantesele-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. DocumentReference.modifierExtension
Definição

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CurtoExtensions that cannot be ignored
Comentários

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Controlo0..*
TipoExtension
É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Resumofalse
Requisitos

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Nomes alternativosextensions, user content
Invariantesele-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. DocumentReference.masterIdentifier
Definição

Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

CurtoMaster Version Specific Identifier
Comentários

CDA Document Id extension and root.

Controlo0..1
TipoIdentifier
É modificadorfalse
Resumotrue
Requisitos

The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).

Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. DocumentReference.identifier
Definição

Other identifiers associated with the document, including version independent identifiers.

CurtoOther identifiers for the document
NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..*
TipoIdentifier
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. DocumentReference.status
Definição

The status of this document reference.

Curtocurrent | superseded | entered-in-error
Comentários

This is the status of the DocumentReference object, which might be independent from the docStatus element.

This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.

Controlo1..1
VínculoOs códigos DEVERÃO ser retirados de DocumentReferenceStatus
(required to http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1)

The status of the document reference.

Tipocode
É modificadortrue porque This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. DocumentReference.docStatus
Definição

The status of the underlying document.

Curtopreliminary | final | amended | entered-in-error
Comentários

The document that is pointed to might be in various lifecycle states.

Controlo0..1
VínculoOs códigos DEVERÃO ser retirados de CompositionStatus
(required to http://hl7.org/fhir/ValueSet/composition-status|4.0.1)

Status of the underlying document.

Tipocode
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. DocumentReference.type
Definição

Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

CurtoKind of document (LOINC if possible)
Comentários

Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.

Controlo0..1
VínculoOs códigos DEVERÃO ser retirados de DocumentTypeValueSet
(preferred to http://hl7.org/fhir/ValueSet/c80-doc-typecodes)

Precise type of clinical document.

TipoCodeableConcept
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. DocumentReference.category
Definição

A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

CurtoCategorization of document
Comentários

Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.

Controlo0..*
VínculoPara exemplos de códigos, ver DocumentClassValueSet
(example to http://hl7.org/fhir/ValueSet/document-classcodes)

High-level kind of a clinical document at a macro level.

TipoCodeableConcept
É modificadorfalse
Resumotrue
Nomes alternativosclaxs
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. DocumentReference.subject
Definição

Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

CurtoWho/what is the subject of the document
Controlo0..1
TipoReference(Patient, Practitioner, Group, Device)
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. DocumentReference.date
Definição

When the document reference was created.

CurtoWhen this document reference was created
Comentários

Referencing/indexing time is used for tracking, organizing versions and searching.

Controlo0..1
Tipoinstant
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Nomes alternativosindexed
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. DocumentReference.author
Definição

Identifies who is responsible for adding the information to the document.

CurtoWho and/or what authored the document
Comentários

Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

Controlo0..*
TipoReference(Practitioner, PractitionerRole, Organization, Device, Patient, RelatedPerson)
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. DocumentReference.authenticator
Definição

Which person or organization authenticates that this document is valid.

CurtoWho/what authenticated the document
Comentários

Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.

Controlo0..1
TipoReference(Practitioner, PractitionerRole, Organization)
É modificadorfalse
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. DocumentReference.custodian
Definição

Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

CurtoOrganization which maintains the document
Comentários

Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.

Controlo0..1
TipoReference(Organization)
É modificadorfalse
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. DocumentReference.relatesTo
Definição

Relationships that this document has with other document references that already exist.

CurtoRelationships to other documents
Comentários

This element is labeled as a modifier because documents that append to other documents are incomplete on their own.

Controlo0..*
TipoBackboneElement
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. DocumentReference.relatesTo.id
Definição

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

CurtoUnique id for inter-element referencing
Controlo0..1
Tipostring
É modificadorfalse
Formato XMLNo formato XML, esta propriedade é representada como um atributo.
Resumofalse
44. DocumentReference.relatesTo.extension
Definição

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CurtoAdditional content defined by implementations
Comentários

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Controlo0..*
TipoExtension
É modificadorfalse
Resumofalse
Nomes alternativosextensions, user content
Invariantesele-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())
46. DocumentReference.relatesTo.modifierExtension
Definição

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CurtoExtensions that cannot be ignored even if unrecognized
Comentários

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Controlo0..*
TipoExtension
É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumotrue
Requisitos

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Nomes alternativosextensions, user content, modifiers
Invariantesele-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())
48. DocumentReference.relatesTo.code
Definição

The type of relationship that this document has with anther document.

Curtoreplaces | transforms | signs | appends
Comentários

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

Controlo1..1
VínculoOs códigos DEVERÃO ser retirados de DocumentRelationshipType
(required to http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1)

The type of relationship between documents.

Tipocode
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. DocumentReference.relatesTo.target
Definição

The target document of this relationship.

CurtoTarget of the relationship
Controlo1..1
TipoReference(DocumentReference)
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. DocumentReference.description
Definição

Human-readable description of the source document.

CurtoHuman-readable description
Comentários

What the document is about, a terse summary of the document.

Controlo0..1
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Requisitos

Helps humans to assess whether the document is of interest.

Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. DocumentReference.securityLabel
Definição

A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

CurtoDocument security-tags
Comentários

The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce.

In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.

Controlo0..*
VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de All Security Labels
(extensible to http://hl7.org/fhir/ValueSet/security-labels)

Security Labels from the Healthcare Privacy and Security Classification System.

TipoCodeableConcept
É modificadorfalse
Resumotrue
Requisitos

Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.

Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. DocumentReference.content
Definição

The document and format referenced. There may be multiple content element repetitions, each with a different format.

CurtoDocument referenced
Controlo1..*
TipoBackboneElement
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. DocumentReference.content.id
Definição

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

CurtoUnique id for inter-element referencing
Controlo0..1
Tipostring
É modificadorfalse
Formato XMLNo formato XML, esta propriedade é representada como um atributo.
Resumofalse
60. DocumentReference.content.extension
Definição

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CurtoAdditional content defined by implementations
Comentários

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Controlo0..*
TipoExtension
É modificadorfalse
Resumofalse
Nomes alternativosextensions, user content
Invariantesele-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. DocumentReference.content.modifierExtension
Definição

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CurtoExtensions that cannot be ignored even if unrecognized
Comentários

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Controlo0..*
TipoExtension
É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumotrue
Requisitos

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Nomes alternativosextensions, user content, modifiers
Invariantesele-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. DocumentReference.content.attachment
Definição

The document or URL of the document along with critical metadata to prove content has integrity.

CurtoDeve incluir SHA-256 do conteúdo do anexo
Controlo1..1
TipoAttachment(Anexo para assinar)
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. DocumentReference.content.format
Definição

An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

CurtoFormat/content rules for the document
Comentários

Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.

Controlo0..1
VínculoOs códigos DEVERÃO ser retirados de DocumentReferenceFormatCodeSet
(preferred to http://hl7.org/fhir/ValueSet/formatcodes)

Document Format Codes.

TipoCoding
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. DocumentReference.context
Definição

The clinical context in which the document was prepared.

CurtoClinical context of document
Comentários

These values are primarily added to help with searching for interesting/relevant documents.

Controlo0..1
TipoBackboneElement
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. DocumentReference.context.id
Definição

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

CurtoUnique id for inter-element referencing
Controlo0..1
Tipostring
É modificadorfalse
Formato XMLNo formato XML, esta propriedade é representada como um atributo.
Resumofalse
72. DocumentReference.context.extension
Definição

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

CurtoAdditional content defined by implementations
Comentários

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Controlo0..*
TipoExtension
É modificadorfalse
Resumofalse
Nomes alternativosextensions, user content
Invariantesele-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())
74. DocumentReference.context.modifierExtension
Definição

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

CurtoExtensions that cannot be ignored even if unrecognized
Comentários

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Controlo0..*
TipoExtension
É modificadortrue porque Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Resumotrue
Requisitos

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Nomes alternativosextensions, user content, modifiers
Invariantesele-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())
76. DocumentReference.context.encounter
Definição

Describes the clinical encounter or type of care that the document content is associated with.

CurtoContext of the document content
Controlo0..*
TipoReference(Encounter, EpisodeOfCare)
É modificadorfalse
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. DocumentReference.context.event
Definição

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

CurtoMain clinical acts documented
Comentários

An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.

Controlo0..*
VínculoPara exemplos de códigos, ver v3 Code System ActCode
(example to http://terminology.hl7.org/ValueSet/v3-ActCode)

This list of codes represents the main clinical acts being documented.

TipoCodeableConcept
É modificadorfalse
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. DocumentReference.context.period
Definição

The time period over which the service that is described by the document was provided.

CurtoTime of service that is being documented
Controlo0..1
TipoPeriod
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. DocumentReference.context.facilityType
Definição

The kind of facility where the patient was seen.

CurtoKind of facility where patient was seen
Controlo0..1
VínculoPara exemplos de códigos, ver FacilityTypeCodeValueSet
(example to http://hl7.org/fhir/ValueSet/c80-facilitycodes)

XDS Facility Type.

TipoCodeableConcept
É modificadorfalse
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. DocumentReference.context.practiceSetting
Definição

This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

CurtoAdditional details about where the content was created (e.g. clinical specialty)
Comentários

This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.

Controlo0..1
VínculoPara exemplos de códigos, ver PracticeSettingCodeValueSet
(example to http://hl7.org/fhir/ValueSet/c80-practice-codes)

Additional details about where the content was created (e.g. clinical specialty).

TipoCodeableConcept
É modificadorfalse
Resumofalse
Requisitos

This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.

Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. DocumentReference.context.sourcePatientInfo
Definição

The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

CurtoPatient demographics from source
Controlo0..1
TipoReference(Patient)
É modificadorfalse
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. DocumentReference.context.related
Definição

Related identifiers or resources associated with the DocumentReference.

CurtoRelated identifiers or resources
Comentários

May be identifiers or resources that caused the DocumentReference or referenced Document to be created.

Controlo0..*
TipoReference(Resource)
É modificadorfalse
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))