Implementation Guide for Portuguese Use Cases

ProfilesPTTransversais/BundlePTTRV.StructureDefinition.json

Tree view

BundlePTTRV (Bundle)	I		BundlePTCore	There are no (further) constraints on this element Element id Bundle Short description Contains a collection of resources Definition A container for a collection of resources. Data type BundlePTCore Constraints bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) `(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()` bdl-9: A document must have an identifier with a system and a value `type = 'document' implies (identifier.system.exists() and identifier.value.exists())` bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))` bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))` bdl-12: A message must have a MessageHeader as the first resource `type = 'message' implies entry.first().resource.is(MessageHeader)` bdl-1: total only when a search or history `total.empty() or (type = 'searchset') or (type = 'history')` bdl-2: entry.search only when a search `entry.search.empty() or (type = 'searchset')` bdl-11: A document must have a Composition as the first resource `type = 'document' implies entry.first().resource.is(Composition)` bdl-10: A document must have a date `type = 'document' implies (timestamp.hasValue())` Mappings rim: Entity. Role, or Act v2: N/A rim: N/A cda: ClinicalDocument, if bundle.type = document w5: infrastructure.structure
id	Σ	1..1	id	There are no (further) constraints on this element Element id Bundle.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type id
meta	Σ	1..1	MetaPTCore	Element id Bundle.meta Short description Metadata about the resource Definition Metadados do recurso. Data type MetaPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a rim: N/A
id		0..0	id	There are no (further) constraints on this element Element id Bundle.meta.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type id Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Bundle.meta.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
versionId	Σ	0..1	id	There are no (further) constraints on this element Element id Bundle.meta.versionId Short description Version specific identifier Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. Comments The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. Data type id Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
lastUpdated	Σ	1..1	instant	There are no (further) constraints on this element Element id Bundle.meta.lastUpdated Short description When the resource version last changed Definition When the resource last changed - e.g. when the version changed. Comments This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. Data type instant Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
source	Σ	0..0	uri	There are no (further) constraints on this element Element id Bundle.meta.source Short description Identifies where the resource comes from Definition A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. Comments In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. Data type uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
profile	Σ	1..1	canonical(StructureDefinition)	There are no (further) constraints on this element Element id Bundle.meta.profile Short description Profiles this resource claims to conform to Definition A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. Data type canonical(StructureDefinition) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
security	Σ	0..0	CodingBinding	There are no (further) constraints on this element Element id Bundle.meta.security Short description Security Labels applied to this resource Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. Comments The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Data type Coding Binding All Security Labels (extensible) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding
tag	Σ	0..0	Coding	There are no (further) constraints on this element Element id Bundle.meta.tag Short description Tags applied to this resource Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Data type Coding Binding CommonTags (example) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding
implicitRules	Σ ?!	0..0	uri	There are no (further) constraints on this element Element id Bundle.implicitRules Short description A set of rules under which this content was created Definition 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. Comments 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
language		0..0	codeBinding	There are no (further) constraints on this element Element id Bundle.language Short description Language of the resource content Definition The base language in which the resource is written. Comments 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). Data type code Binding IETF language tag CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
identifier	Σ	0..1	ExtensionIdentifierPTCore	There are no (further) constraints on this element Element id Bundle.identifier Short description Persistent identifier for the bundle Definition A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Comments Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique. Data type ExtensionIdentifierPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier cda: ClinicalDocument.id
id		0..1	id	There are no (further) constraints on this element Element id Bundle.identifier.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type id Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Bundle.identifier.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
use	Σ ?!	0..0	codeBinding	There are no (further) constraints on this element Element id Bundle.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition Propósito do identificador: official: O identificador considerado mais fiável para a identificação do item. temp: Um identificador temporário. secondary: Um identificador que foi atribuído para identificar o item em um contexto relativo, mas não pode usado em um contexto diferente. old: O identificador já não é considerado válido, mas pode ser relevante para fins de pesquisa. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptPTCoreBinding	There are no (further) constraints on this element Element id Bundle.identifier.type Short description Concept - reference to a terminology or just text Definition A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments Value Set: ExtensionIdentifierType Data type CodeableConceptPTCore Binding ExtensionIdentifierType (extensible) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD v2: CX.5 rim: Role.code or implied by context
id		0..1	id	There are no (further) constraints on this element Element id Bundle.identifier.type.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type id Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Bundle.identifier.type.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
coding	Σ	0..*	CodingPTCore	There are no (further) constraints on this element Element id Bundle.identifier.type.coding Short description A reference to a code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data type CodingPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	id	Element id Bundle.identifier.type.coding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Comments .. Data type id Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Bundle.identifier.type.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
system	Σ	1..1	uri	There are no (further) constraints on this element Element id Bundle.identifier.type.coding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..0	string	There are no (further) constraints on this element Element id Bundle.identifier.type.coding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	1..1	code	There are no (further) constraints on this element Element id Bundle.identifier.type.coding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	1..1	string	There are no (further) constraints on this element Element id Bundle.identifier.type.coding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..0	boolean	There are no (further) constraints on this element Element id Bundle.identifier.type.coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	1..1	string	There are no (further) constraints on this element Element id Bundle.identifier.type.text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
system	Σ	0..1	uri	There are no (further) constraints on this element Element id Bundle.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements 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. Comments Para sistemas geridos pela SPMS o system tem de seguir a seguinte estrutura: http://spms.min-saude.pt/<sistema>/identifiers/<identifier-id> Data type uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Examples General http://www.acme.com/identifiers/patient Mappings rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Bundle.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Examples General 123456 Mappings rim: n/a v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ I	0..1	PeriodPTCore	There are no (further) constraints on this element Element id Bundle.identifier.period Short description Time range defined by start and end date/time Alternate names Period Definition A time period defined by a start and end date and optionally time. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type PeriodPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ I	0..0	Reference(OrganizationPTCore)	There are no (further) constraints on this element Element id Bundle.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments 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. Data type Reference(OrganizationPTCore) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id Bundle.type Short description document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Definition Obrigatório a identificação de um dos seguintes códigos: “document” - O Bundle é do tipo documento. O primeiro recurso é o Composition. “message” - O Bundle é do tipo mensagem. O primeiro recurso é o MessageHeader. “transaction” - O Bundle do tipo transação. “transaction-response” - O Bundle é uma resposta a uma mensagem com tipo de Bundle transaction. “batch” - O Bundle é um conjunto de ações. “batch-response” - O Bundle é uma resposta a uma mensagem com tipo de Bundle batch. “history” - O Bundle é uma lista de recursos referente a uma interação de dados históricos. “searchset”- O Bundle é uma lista de resultados de uma pesquisa. “collection” - O Bundle é um conjunto de recursos agrupados num único pacote. Comments It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Data type code Binding Indicates the purpose of a bundle - how it is intended to be used. BundleType (required) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a w5: FiveWs.class
timestamp	Σ	0..1	instant	Element id Bundle.timestamp Short description When the bundle was assembled Definition No caso de Bundle.Type: "message", corresponde à data em que o conteúdo da mensagem foi criado. Comments For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage: document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query transaction \| transaction-response \| batch \| batch-response \| collection : no particular assigned meaning The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself. Data type instant Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a w5: FiveWs.init cda: ClinicalDocument.effectiveTime
total	Σ I	0..0	unsignedInt	There are no (further) constraints on this element Element id Bundle.total Short description If search, the total number of matches Definition Usado apenas no caso do Bundle.Type com valor search ou history. Comments Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources. Data type unsignedInt Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
link	Σ	0..0	BackboneElement	There are no (further) constraints on this element Element id Bundle.link Short description Links related to this Bundle Definition Lista de links relacionados com o bundle Comments Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
entry	Σ I	1..*	BackboneElement	There are no (further) constraints on this element Element id Bundle.entry Short description Entry in the bundle - will have a resource or information Definition An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` bdl-8: fullUrl cannot be a version specific reference `fullUrl.exists() implies fullUrl.contains('/_history/').not()` bdl-5: must be a resource unless there's a request or response `resource.exists() or request.exists() or response.exists()` Mappings rim: n/a
id		0..0	id	There are no (further) constraints on this element Element id Bundle.entry.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type id Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Bundle.entry.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Bundle.entry.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition 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). Requirements 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. Comments 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
link	Σ	0..0	see (link)	There are no (further) constraints on this element Element id Bundle.entry.link Short description Links related to this entry Definition Lista de links relacionados com a entrada
fullUrl	Σ	1..1	uri	There are no (further) constraints on this element Element id Bundle.entry.fullUrl Short description URI for resource (Absolute URL server address or URI for UUID/OID) Definition The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified. Comments fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). Data type uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
resource	Σ	1..1	Resource	There are no (further) constraints on this element Element id Bundle.entry.resource Short description A resource in the bundle Definition Recurso referenciado pelo Bundle, respeitando as regras da entry. Data type Resource Mappings rim: Entity. Role, or Act
search	Σ I	0..0	BackboneElement	There are no (further) constraints on this element Element id Bundle.entry.search Short description Search related information Definition Information about the search process that lead to the creation of this entry. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
request	Σ I	0..0	BackboneElement	There are no (further) constraints on this element Element id Bundle.entry.request Short description Additional execution information (transaction/batch/history) Definition Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
response	Σ I	0..0	BackboneElement	There are no (further) constraints on this element Element id Bundle.entry.response Short description Results of execution (transaction/batch/history) Definition Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
signature	Σ	0..0	Signature	There are no (further) constraints on this element Element id Bundle.signature Short description Digital Signature Definition Assinatura digital Requirements A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. Comments The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific. Data type Signature Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a rim: N/A

Binding

Path	Strength	ValueSet	Comment
Identifier.type	extensible	https://spms.min-saude.pt/iop/valueset/ExtensionIdentifierType	Value Set: ExtensionIdentifierType

Path

Strength

ValueSet

Comment

Identifier.type

extensible

https://spms.min-saude.pt/iop/valueset/ExtensionIdentifierType

Value Set: ExtensionIdentifierType

Binding do FHIR Required

Path	Strength	ValueSet
Bundle.type	required	BundleType

Identifiers Type

Estes Identificadores devem ser utilizados no elemento

identifier.type.coding[*]

Regras de implementação

Para além das constraints identificadas pelo FHIR para este recurso devem ser consideradas as constraints que identificamos na tabela infra.

Voltar ao início