FHIR dokument

Osnovni podatci svih FHIR dokumenata. Svi FHIR dokumenti moraju zadovoljavati sve zahtjeve ove specifikacije.

Specifikacija profila

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
typeΣ1..1codeBindingFixed Value
timestampΣ1..1instant
totalΣ I0..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
relationΣ1..1string
urlΣ1..1uri
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
fullUrlΣ0..1uri
resourceΣ0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionI0..*Extension
typeΣ1..1CodingBindingFixed Value
whenΣ1..1instant
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..0uriBinding
identifierΣ0..0Identifier
displayΣ0..1string
onBehalfOfΣ I0..0Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)
targetFormat0..0codeBinding
sigFormat0..0codeBinding
data1..1base64Binary
Bundle
DefinitionA container for a collection of resources.
Cardinality0...*
Invariants
  • 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())
  • DOC-1: Document must be signed by author of document
    Bundle.entry.resource.ofType(Composition).author.resolve().ofType(Practitioner) = Bundle.signature.who.resolve()
Mappings
  • rim: Entity. Role, or Act
  • v2: N/A
  • rim: N/A
  • cda: ClinicalDocument, if bundle.type = document
Bundle.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
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.

Bundle.meta
DefinitionThe 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.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Bundle.implicitRules
DefinitionA 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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.identifier
DefinitionOvaj identifikator jedinstveno definira dokument i njegovu verziju. Ukoliko je potrebno kreirati novu verziju dokumenta novoj verziji dokumenta se dodjeljuje novi identifikator i u zaglavlju dokumenta (Composition) se definira koju verziju dokumenta zamjenjuje ova verzija). Format identifikatora je OID. Korištenjem ovog idewntifikatora moguće je dohvatiti dokument iz repozitorija dokumenata
Cardinality1...1
TypeIdentifier
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • DOC-2: Document identifier must be in OID format ad begin with urn:oid:([1-9][0-9]{0,3}|0){1,4}(\\.([1-9][0-9]{0,32}|0)){5,13}$
    value.matches("^urn:oid:.*")
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
Bundle.identifier.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Bundle.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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
Bundle.identifier.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
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

Identifier.system is always case sensitive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

urn:ietf:rfc:3986

Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Bundle.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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
Bundle.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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
Bundle.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(Organization)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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'))
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
Bundle.type
DefinitionDefinira što predstavlja resurs Bundle. U ovom slučaju predstavlja FHIR dokument
Cardinality1...1
Typecode
Binding

Indicates the purpose of a bundle - how it is intended to be used.

BundleType (required)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

document

Mappings
  • rim: n/a
  • w5: FiveWs.class
Bundle.timestamp
DefinitionThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
Cardinality1...1
Typeinstant
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.init
  • cda: ClinicalDocument.effectiveTime
Bundle.total
DefinitionIf a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
Cardinality0...1
TypeunsignedInt
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.link
DefinitionA series of links that provide context to this bundle.
Cardinality0...*
TypeBackboneElement
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.link.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.link.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.link.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.link.relation
DefinitionA name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).
Cardinality1...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.link.url
DefinitionThe reference details for the link.
Cardinality1...1
Typeuri
SummaryTrue
Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry
DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Cardinality0...*
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • bdl-8: fullUrl cannot be a version specific reference
    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
Bundle.entry.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.entry.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.link
DefinitionA series of links that provide context to this entry.
Cardinality0...*
Typesee (link)
SummaryTrue
Bundle.entry.fullUrl
DefinitionThe 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.
Cardinality0...1
Typeuri
SummaryTrue
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.resource
DefinitionThe Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.
Cardinality0...1
TypeResource
SummaryTrue
Mappings
  • rim: Entity. Role, or Act
Bundle.entry.search
DefinitionInformation about the search process that lead to the creation of this entry.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.search.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.entry.search.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.search.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.search.mode
DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Cardinality0...1
Typecode
Binding

Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

SearchEntryMode (required)
SummaryTrue
Comments

There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.search.score
DefinitionWhen searching, the server's search ranking score for the entry.
Cardinality0...1
Typedecimal
SummaryTrue
Comments

Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.

See Patient Match for the EMPI search which relates to this element.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request
DefinitionAdditional 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.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.entry.request.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.request.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.request.method
DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.
Cardinality1...1
Typecode
Binding

HTTP verbs (in the HTTP command line). See HTTP rfc for details.

HTTPVerb (required)
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.url
DefinitionThe URL for this entry, relative to the root (the address to which the request is posted).
Cardinality1...1
Typeuri
SummaryTrue
Comments

E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.ifNoneMatch
DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).
Cardinality0...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.ifModifiedSince
DefinitionOnly perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).
Cardinality0...1
Typeinstant
SummaryTrue
Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.ifMatch
DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).
Cardinality0...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.request.ifNoneExist
DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").
Cardinality0...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response
DefinitionIndicates 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.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.entry.response.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.response.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.entry.response.status
DefinitionThe status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.
Cardinality1...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response.location
DefinitionThe location header created by processing this operation, populated if the operation returns a location.
Cardinality0...1
Typeuri
SummaryTrue
Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response.etag
DefinitionThe Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).
Cardinality0...1
Typestring
SummaryTrue
Comments

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response.lastModified
DefinitionThe date/time that the resource was modified on the server.
Cardinality0...1
Typeinstant
SummaryTrue
Comments

This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.response.outcome
DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
Cardinality0...1
TypeResource
SummaryTrue
Comments

For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.

Mappings
  • rim: Entity. Role, or Act
Bundle.signature
DefinitionDigital Signature - base64 encoded. XML-DSig or a JWT.
Cardinality1...1
TypeSignature
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Bundle.signature.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.signature.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.signature.type
DefinitionDefinira da je potpisnik poruke autor
Cardinality1...1
TypeCoding
Binding

An indication of the reason that an entity signed the object.

SignatureTypeCodes (preferred)
SummaryTrue
Comments

Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

{
  "system": "urn:iso-astm:E1762-95:2013",
  "code": "1.2.840.10065.1.12.1.1"
}

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
Bundle.signature.when
DefinitionWhen the digital signature was signed.
Cardinality1...1
Typeinstant
SummaryTrue
Comments

This should agree with the information in the signature.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.signature.who
DefinitionPotpisnik dokumenta je jednak autoru poruke navedenom u Composition.author atributu. Koristi se logička referenca (identifikator-MBO)
Cardinality1...1
TypeReference(HRPractitioner)
SummaryTrue
Comments

This should agree with the information in the signature.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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'))
  • DOC-3: Local reference must be used to specify signer of document
    reference.matches("^urn:uuid:.*")
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Bundle.signature.who.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Bundle.signature.who.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Bundle.signature.who.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality1...1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Bundle.signature.who.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...0
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Bundle.signature.who.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...0
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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
  • rim: .identifier
Bundle.signature.who.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Bundle.signature.onBehalfOf
DefinitionA reference to an application-usable description of the identity that is represented by the signature.
Cardinality0...0
TypeReference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)
SummaryTrue
Requirements

used when the signature is on behalf of a non-signer.

Comments

The party that can't sign. For example a child.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Bundle.signature.targetFormat
DefinitionA mime type that indicates the technical format of the target resources signed by the signature.
Cardinality0...0
Typecode
Binding

The mime type of an attachment. Any valid mime type is allowed.

Mime Types (required)
Comments

"xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.signature.sigFormat
DefinitionA mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.
Cardinality0...0
Typecode
Binding

The mime type of an attachment. Any valid mime type is allowed.

Mime Types (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.signature.data
DefinitionThe base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
Cardinality1...1
Typebase64Binary
Comments

Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="hr-document" />
    <url value="http://fhir.cezih.hr/specifikacije/StructureDefinition/hr-document" />
    <version value="0.1" />
    <name value="HRDocument" />
    <title value="Osnovni podatci FHIR Dokumenata" />
    <status value="active" />
    <experimental value="false" />
    <date value="2022-09-28" />
    <description value="Osnovni podatci svih FHIR dokumenata. Svi FHIR dokumenti moraju zadovoljavati sve zahtjeve ove specifikacije" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Bundle" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" />
    <derivation value="constraint" />
    <differential>
        <element id="Bundle">
            <path value="Bundle" />
            <constraint>
                <key value="DOC-1" />
                <severity value="error" />
                <human value="Document must be signed by author of document" />
                <expression value="Bundle.entry.resource.ofType(Composition).author.resolve().ofType(Practitioner) = Bundle.signature.who.resolve()" />
            </constraint>
        </element>
        <element id="Bundle.language">
            <path value="Bundle.language" />
            <short value="Jezik dokumenta" />
        </element>
        <element id="Bundle.identifier">
            <path value="Bundle.identifier" />
            <short value="Jedinstveni identifikator dokumenta" />
            <definition value="Ovaj identifikator jedinstveno definira dokument i njegovu verziju. Ukoliko je potrebno kreirati novu verziju dokumenta novoj verziji dokumenta se dodjeljuje novi identifikator i u zaglavlju dokumenta (Composition) se definira koju verziju dokumenta zamjenjuje ova verzija). Format identifikatora je OID.\nKorištenjem ovog idewntifikatora moguće je dohvatiti dokument iz repozitorija dokumenata" />
            <min value="1" />
            <constraint>
                <key value="DOC-2" />
                <severity value="error" />
                <human value="Document identifier must be in OID format ad begin with urn:oid:([1-9][0-9]{0,3}|0){1,4}(\\.([1-9][0-9]{0,32}|0)){5,13}$" />
                <expression value="value.matches(&quot;^urn:oid:.*&quot;)" />
            </constraint>
        </element>
        <element id="Bundle.identifier.system">
            <path value="Bundle.identifier.system" />
            <min value="1" />
            <fixedUri value="urn:ietf:rfc:3986" />
        </element>
        <element id="Bundle.identifier.value">
            <path value="Bundle.identifier.value" />
            <min value="1" />
        </element>
        <element id="Bundle.type">
            <path value="Bundle.type" />
            <short value="Vrsta Bundle resursa" />
            <definition value="Definira što predstavlja resurs Bundle. U ovom slučaju predstavlja FHIR dokument" />
            <fixedCode value="document" />
        </element>
        <element id="Bundle.timestamp">
            <path value="Bundle.timestamp" />
            <short value="Vrijeme kreiranja dokumenta" />
            <min value="1" />
        </element>
        <element id="Bundle.signature">
            <path value="Bundle.signature" />
            <short value="Digitalni potpis dokumenta" />
            <min value="1" />
        </element>
        <element id="Bundle.signature.type">
            <path value="Bundle.signature.type" />
            <short value="Definira vrstu digitalnog potpisa" />
            <definition value="Definira da je potpisnik poruke autor" />
            <max value="1" />
            <fixedCoding>
                <system value="urn:iso-astm:E1762-95:2013" />
                <code value="1.2.840.10065.1.12.1.1" />
            </fixedCoding>
        </element>
        <element id="Bundle.signature.when">
            <path value="Bundle.signature.when" />
            <short value="Vrijeme kreiranja digitalnog potpisa dokumenta" />
        </element>
        <element id="Bundle.signature.who">
            <path value="Bundle.signature.who" />
            <short value="Referenca na potpisnika dokumenta" />
            <definition value="Potpisnik dokumenta je jednak autoru poruke navedenom u Composition.author atributu. Koristi se logička referenca (identifikator-MBO)" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.cezih.hr/specifikacije/StructureDefinition/hr-practitioner" />
            </type>
            <constraint>
                <key value="DOC-3" />
                <severity value="error" />
                <human value="Local reference must be used to specify signer of document" />
                <expression value="reference.matches(&quot;^urn:uuid:.*&quot;)" />
            </constraint>
        </element>
        <element id="Bundle.signature.who.reference">
            <path value="Bundle.signature.who.reference" />
            <min value="1" />
        </element>
        <element id="Bundle.signature.who.type">
            <path value="Bundle.signature.who.type" />
            <max value="0" />
        </element>
        <element id="Bundle.signature.who.identifier">
            <path value="Bundle.signature.who.identifier" />
            <max value="0" />
        </element>
        <element id="Bundle.signature.onBehalfOf">
            <path value="Bundle.signature.onBehalfOf" />
            <max value="0" />
        </element>
        <element id="Bundle.signature.targetFormat">
            <path value="Bundle.signature.targetFormat" />
            <max value="0" />
        </element>
        <element id="Bundle.signature.sigFormat">
            <path value="Bundle.signature.sigFormat" />
            <max value="0" />
        </element>
        <element id="Bundle.signature.data">
            <path value="Bundle.signature.data" />
            <short value="Digitalni potpis" />
            <min value="1" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "hr-document",
    "url": "http://fhir.cezih.hr/specifikacije/StructureDefinition/hr-document",
    "version": "0.1",
    "name": "HRDocument",
    "title": "Osnovni podatci FHIR Dokumenata",
    "status": "active",
    "experimental": false,
    "date": "2022-09-28",
    "description": "Osnovni podatci svih FHIR dokumenata. Svi FHIR dokumenti moraju zadovoljavati sve zahtjeve ove specifikacije",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Bundle",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Bundle",
                "path": "Bundle",
                "constraint":  [
                    {
                        "key": "DOC-1",
                        "severity": "error",
                        "human": "Document must be signed by author of document",
                        "expression": "Bundle.entry.resource.ofType(Composition).author.resolve().ofType(Practitioner) = Bundle.signature.who.resolve()"
                    }
                ]
            },
            {
                "id": "Bundle.language",
                "path": "Bundle.language",
                "short": "Jezik dokumenta"
            },
            {
                "id": "Bundle.identifier",
                "path": "Bundle.identifier",
                "short": "Jedinstveni identifikator dokumenta",
                "definition": "Ovaj identifikator jedinstveno definira dokument i njegovu verziju. Ukoliko je potrebno kreirati novu verziju dokumenta novoj verziji dokumenta se dodjeljuje novi identifikator i u zaglavlju dokumenta (Composition) se definira koju verziju dokumenta zamjenjuje ova verzija). Format identifikatora je OID.\nKorištenjem ovog idewntifikatora moguće je dohvatiti dokument iz repozitorija dokumenata",
                "min": 1,
                "constraint":  [
                    {
                        "key": "DOC-2",
                        "severity": "error",
                        "human": "Document identifier must be in OID format ad begin with urn:oid:([1-9][0-9]{0,3}|0){1,4}(\\\\.([1-9][0-9]{0,32}|0)){5,13}$",
                        "expression": "value.matches(\"^urn:oid:.*\")"
                    }
                ]
            },
            {
                "id": "Bundle.identifier.system",
                "path": "Bundle.identifier.system",
                "min": 1,
                "fixedUri": "urn:ietf:rfc:3986"
            },
            {
                "id": "Bundle.identifier.value",
                "path": "Bundle.identifier.value",
                "min": 1
            },
            {
                "id": "Bundle.type",
                "path": "Bundle.type",
                "short": "Vrsta Bundle resursa",
                "definition": "Definira što predstavlja resurs Bundle. U ovom slučaju predstavlja FHIR dokument",
                "fixedCode": "document"
            },
            {
                "id": "Bundle.timestamp",
                "path": "Bundle.timestamp",
                "short": "Vrijeme kreiranja dokumenta",
                "min": 1
            },
            {
                "id": "Bundle.signature",
                "path": "Bundle.signature",
                "short": "Digitalni potpis dokumenta",
                "min": 1
            },
            {
                "id": "Bundle.signature.type",
                "path": "Bundle.signature.type",
                "short": "Definira vrstu digitalnog potpisa",
                "definition": "Definira da je potpisnik poruke autor",
                "max": "1",
                "fixedCoding": {
                    "system": "urn:iso-astm:E1762-95:2013",
                    "code": "1.2.840.10065.1.12.1.1"
                }
            },
            {
                "id": "Bundle.signature.when",
                "path": "Bundle.signature.when",
                "short": "Vrijeme kreiranja digitalnog potpisa dokumenta"
            },
            {
                "id": "Bundle.signature.who",
                "path": "Bundle.signature.who",
                "short": "Referenca na potpisnika dokumenta",
                "definition": "Potpisnik dokumenta je jednak autoru poruke navedenom u Composition.author atributu. Koristi se logička referenca (identifikator-MBO)",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.cezih.hr/specifikacije/StructureDefinition/hr-practitioner"
                        ]
                    }
                ],
                "constraint":  [
                    {
                        "key": "DOC-3",
                        "severity": "error",
                        "human": "Local reference must be used to specify signer of document",
                        "expression": "reference.matches(\"^urn:uuid:.*\")"
                    }
                ]
            },
            {
                "id": "Bundle.signature.who.reference",
                "path": "Bundle.signature.who.reference",
                "min": 1
            },
            {
                "id": "Bundle.signature.who.type",
                "path": "Bundle.signature.who.type",
                "max": "0"
            },
            {
                "id": "Bundle.signature.who.identifier",
                "path": "Bundle.signature.who.identifier",
                "max": "0"
            },
            {
                "id": "Bundle.signature.onBehalfOf",
                "path": "Bundle.signature.onBehalfOf",
                "max": "0"
            },
            {
                "id": "Bundle.signature.targetFormat",
                "path": "Bundle.signature.targetFormat",
                "max": "0"
            },
            {
                "id": "Bundle.signature.sigFormat",
                "path": "Bundle.signature.sigFormat",
                "max": "0"
            },
            {
                "id": "Bundle.signature.data",
                "path": "Bundle.signature.data",
                "short": "Digitalni potpis",
                "min": 1
            }
        ]
    }
}