SPL Mapping FHIR Implementation Guide
0.1.0 - Build CI
SPL Mapping FHIR Implementation Guide
0.1.0 - Build CI
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
| Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/EstablishmentInactivationBundle | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: EstablishmentInactivationBundle | ||
A profile that represents the Bundle that contains all of the resources for an Estabishment Inactivation Request.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from OrganizationBundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle |
0..* | OrganizationBundle | Contains a collection of resources | |
  Slices for entry |
3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource | |
   entry:Message |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
  resource |
1..1 | EstablishmentInactivationMessage | A resource that describes a message that is exchanged between systems | |
| entry:Registrant |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| resource |
1..1 | IdentifiedEstablishmentRegistrant | A grouping of people or organizations with a common purpose | |
 entry:Establishment |
S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information |
| resource |
1..1 | IdentifiedEstablishment | A grouping of people or organizations with a common purpose | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle |
C | 0..* | OrganizationBundle | 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 |
| Slices for entry |
ΣC | 3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource 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 |
 entry:All Slices |
Content/Rules for all slices | |||
  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 |
| entry:Message |
SΣC | 1..1 | 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 |
 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 |
1..1 | EstablishmentInactivationMessage | A resource that describes a message that is exchanged between systems | |
| entry:Registrant |
SΣC | 1..1 | 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 |
| 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 |
1..1 | IdentifiedEstablishmentRegistrant | A grouping of people or organizations with a common purpose | |
| entry:Establishment |
SΣC | 1..* | 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 |
| 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 |
1..1 | IdentifiedEstablishment | A grouping of people or organizations with a common purpose | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.type | required | Pattern: messagehttp://hl7.org/fhir/ValueSet/bundle-type|4.3.0from the FHIR Standard | |
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | |
| Bundle.entry:Message.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | |
| Bundle.entry:Registrant.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | |
| Bundle.entry:Establishment.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | error | Bundle | 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 | error | Bundle | 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-5 | error | Bundle.entry, Bundle.entry:Message, Bundle.entry:Registrant, Bundle.entry:Establishment | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-7 | error | Bundle | 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-8 | error | Bundle.entry, Bundle.entry:Message, Bundle.entry:Registrant, Bundle.entry:Establishment | fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not() | |
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| spl-2.1.3.11 | error | Bundle | There is an effective time with at least the precision of day. : timestamp.toString().length() >= 10 | |
| spl-X.1.1.2 | error | Bundle | The effective time year is equal to the current year : timestamp.toString().startsWith(today().toString().substring(0,4)) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | OrganizationBundle | 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 | ||||
| Slices for entry |
ΣC | 3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource 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 | ||||
| entry:All Slices |
Content/Rules for all slices | |||||||
| 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 | ||||
| entry:Message |
SΣC | 1..1 | 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 |
1..1 | EstablishmentInactivationMessage | A resource that describes a message that is exchanged between systems | |||||
| entry:Registrant |
SΣC | 1..1 | 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 |
1..1 | IdentifiedEstablishmentRegistrant | A grouping of people or organizations with a common purpose | |||||
| entry:Establishment |
SΣC | 1..* | 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 |
1..1 | IdentifiedEstablishment | A grouping of people or organizations with a common purpose | |||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Bundle.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Bundle.type | required | Pattern: messagehttp://hl7.org/fhir/ValueSet/bundle-type|4.3.0from the FHIR Standard | ||||
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0from the FHIR Standard | ||||
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Message.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Message.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Registrant.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Registrant.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Establishment.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Establishment.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | error | Bundle | 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 | error | Bundle | 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-5 | error | Bundle.entry, Bundle.entry:Message, Bundle.entry:Registrant, Bundle.entry:Establishment | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-7 | error | Bundle | 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-8 | error | Bundle.entry, Bundle.entry:Message, Bundle.entry:Registrant, Bundle.entry:Establishment | fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not() | |
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| spl-2.1.3.11 | error | Bundle | There is an effective time with at least the precision of day. : timestamp.toString().length() >= 10 | |
| spl-X.1.1.2 | error | Bundle | The effective time year is equal to the current year : timestamp.toString().startsWith(today().toString().substring(0,4)) |
This structure is derived from OrganizationBundle
Summary
Mandatory: 3 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from OrganizationBundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle |
0..* | OrganizationBundle | Contains a collection of resources | |
| Slices for entry |
3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource | |
| entry:Message |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| resource |
1..1 | EstablishmentInactivationMessage | A resource that describes a message that is exchanged between systems | |
| entry:Registrant |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
| resource |
1..1 | IdentifiedEstablishmentRegistrant | A grouping of people or organizations with a common purpose | |
| entry:Establishment |
S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information |
| resource |
1..1 | IdentifiedEstablishment | A grouping of people or organizations with a common purpose | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle |
C | 0..* | OrganizationBundle | 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 |
| Slices for entry |
ΣC | 3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource 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 |
| entry:All Slices |
Content/Rules for all slices | |||
| 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 |
| entry:Message |
SΣC | 1..1 | 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 |
| 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 |
1..1 | EstablishmentInactivationMessage | A resource that describes a message that is exchanged between systems | |
| entry:Registrant |
SΣC | 1..1 | 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 |
| 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 |
1..1 | IdentifiedEstablishmentRegistrant | A grouping of people or organizations with a common purpose | |
| entry:Establishment |
SΣC | 1..* | 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 |
| 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 |
1..1 | IdentifiedEstablishment | A grouping of people or organizations with a common purpose | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.type | required | Pattern: messagehttp://hl7.org/fhir/ValueSet/bundle-type|4.3.0from the FHIR Standard | |
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | |
| Bundle.entry:Message.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | |
| Bundle.entry:Registrant.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | |
| Bundle.entry:Establishment.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | error | Bundle | 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 | error | Bundle | 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-5 | error | Bundle.entry, Bundle.entry:Message, Bundle.entry:Registrant, Bundle.entry:Establishment | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-7 | error | Bundle | 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-8 | error | Bundle.entry, Bundle.entry:Message, Bundle.entry:Registrant, Bundle.entry:Establishment | fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not() | |
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| spl-2.1.3.11 | error | Bundle | There is an effective time with at least the precision of day. : timestamp.toString().length() >= 10 | |
| spl-X.1.1.2 | error | Bundle | The effective time year is equal to the current year : timestamp.toString().startsWith(today().toString().substring(0,4)) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | OrganizationBundle | 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 | ||||
| Slices for entry |
ΣC | 3..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource 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 | ||||
| entry:All Slices |
Content/Rules for all slices | |||||||
| 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 | ||||
| entry:Message |
SΣC | 1..1 | 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 |
1..1 | EstablishmentInactivationMessage | A resource that describes a message that is exchanged between systems | |||||
| entry:Registrant |
SΣC | 1..1 | 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 |
1..1 | IdentifiedEstablishmentRegistrant | A grouping of people or organizations with a common purpose | |||||
| entry:Establishment |
SΣC | 1..* | 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 |
1..1 | IdentifiedEstablishment | A grouping of people or organizations with a common purpose | |||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Bundle.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Bundle.type | required | Pattern: messagehttp://hl7.org/fhir/ValueSet/bundle-type|4.3.0from the FHIR Standard | ||||
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0from the FHIR Standard | ||||
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Message.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Message.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Registrant.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Registrant.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Establishment.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0from the FHIR Standard | ||||
| Bundle.entry:Establishment.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.3.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | error | Bundle | 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 | error | Bundle | 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-5 | error | Bundle.entry, Bundle.entry:Message, Bundle.entry:Registrant, Bundle.entry:Establishment | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-7 | error | Bundle | 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-8 | error | Bundle.entry, Bundle.entry:Message, Bundle.entry:Registrant, Bundle.entry:Establishment | fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not() | |
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| spl-2.1.3.11 | error | Bundle | There is an effective time with at least the precision of day. : timestamp.toString().length() >= 10 | |
| spl-X.1.1.2 | error | Bundle | The effective time year is equal to the current year : timestamp.toString().startsWith(today().toString().substring(0,4)) |
This structure is derived from OrganizationBundle
Summary
Mandatory: 3 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Biomedical Research and Regulation. Package hl7.fhir.us.spl#0.1.0 based on FHIR 4.3.0. Generated 2024-05-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change