SPL Mapping FHIR Implementation Guide
0.1.0 - Build CI United States of America flag

SPL Mapping FHIR Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

Resource Profile: OrganizationBundle ( Abstract )

Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/OrganizationBundle Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: OrganizationBundle

A profile that provides the minimum set of information about a Bundle using for Organization messages.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle
Contains a collection of resources
spl-X.1.1.2: The effective time year is equal to the current year
spl-2.1.3.11: There is an effective time with at least the precision of day.
... type S 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: message
... timestamp S 1..1 instant When the bundle was assembled
... entry
.... fullUrl S 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource S 1..1 Resource A resource in the bundle
.... search 0..0
.... request 0..0
.... response 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
spl-2.1.3.11errorBundleThere is an effective time with at least the precision of day.
: timestamp.toString().length() >= 10
spl-X.1.1.2errorBundleThe effective time year is equal to the current year
: timestamp.toString().startsWith(today().toString().substring(0,4))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle
Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
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)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
spl-X.1.1.2: The effective time year is equal to the current year
spl-2.1.3.11: There is an effective time with at least the precision of day.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... timestamp SΣ 1..1 instant When the bundle was assembled
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... fullUrl SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource SΣ 1..1 Resource A resource in the bundle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: message
http://hl7.org/fhir/ValueSet/bundle-type|4.3.0
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.3.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
spl-2.1.3.11errorBundleThere is an effective time with at least the precision of day.
: timestamp.toString().length() >= 10
spl-X.1.1.2errorBundleThe effective time year is equal to the current year
: timestamp.toString().startsWith(today().toString().substring(0,4))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle
Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
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)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
spl-X.1.1.2: The effective time year is equal to the current year
spl-2.1.3.11: There is an effective time with at least the precision of day.
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... timestamp SΣ 1..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... link Σ 0..* See link (Bundle) Links related to this entry
.... fullUrl SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource SΣ 1..1 Resource A resource in the bundle
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.typerequiredPattern: message
http://hl7.org/fhir/ValueSet/bundle-type|4.3.0
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.3.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
spl-2.1.3.11errorBundleThere is an effective time with at least the precision of day.
: timestamp.toString().length() >= 10
spl-X.1.1.2errorBundleThe effective time year is equal to the current year
: timestamp.toString().startsWith(today().toString().substring(0,4))

This structure is derived from Bundle

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 3 elements

Maturity: 1

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle
Contains a collection of resources
spl-X.1.1.2: The effective time year is equal to the current year
spl-2.1.3.11: There is an effective time with at least the precision of day.
... type S 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: message
... timestamp S 1..1 instant When the bundle was assembled
... entry
.... fullUrl S 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource S 1..1 Resource A resource in the bundle
.... search 0..0
.... request 0..0
.... response 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
spl-2.1.3.11errorBundleThere is an effective time with at least the precision of day.
: timestamp.toString().length() >= 10
spl-X.1.1.2errorBundleThe effective time year is equal to the current year
: timestamp.toString().startsWith(today().toString().substring(0,4))

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle
Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
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)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
spl-X.1.1.2: The effective time year is equal to the current year
spl-2.1.3.11: There is an effective time with at least the precision of day.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... timestamp SΣ 1..1 instant When the bundle was assembled
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... fullUrl SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource SΣ 1..1 Resource A resource in the bundle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: message
http://hl7.org/fhir/ValueSet/bundle-type|4.3.0
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.3.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
spl-2.1.3.11errorBundleThere is an effective time with at least the precision of day.
: timestamp.toString().length() >= 10
spl-X.1.1.2errorBundleThe effective time year is equal to the current year
: timestamp.toString().startsWith(today().toString().substring(0,4))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle This is an abstract profile. Child profiles: EstablishmentInactivationBundle, EstablishmentRegistrationBundle, GDUFAFacilityIdentificationBundle, GDUFAFacilityInactivationBundle, LabelerCodeRequestBundle, LabelerInactivationBundle, OutOfBusinessBundle
Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
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)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
spl-X.1.1.2: The effective time year is equal to the current year
spl-2.1.3.11: There is an effective time with at least the precision of day.
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... timestamp SΣ 1..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... link Σ 0..* See link (Bundle) Links related to this entry
.... fullUrl SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource SΣ 1..1 Resource A resource in the bundle
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.typerequiredPattern: message
http://hl7.org/fhir/ValueSet/bundle-type|4.3.0
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.3.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
spl-2.1.3.11errorBundleThere is an effective time with at least the precision of day.
: timestamp.toString().length() >= 10
spl-X.1.1.2errorBundleThe effective time year is equal to the current year
: timestamp.toString().startsWith(today().toString().substring(0,4))

This structure is derived from Bundle

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 3 elements

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron