Bundle - IPS for Hajj - SMART Verifiable IPS for Pilgrimage v1.0.1

SMART Verifiable IPS for Pilgrimage, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-ips-pilgrimage/tree/main and changes regularly. See the Directory of published versions

Resource Profile: Bundle - IPS for Hajj

Official URL: http://smart.who.int/ips-pilgrimage/StructureDefinition/HajjIPS				Version: 1.0.1
Draft as of 2024-11-22				Computable Name: HajjIPS

This profile represents the constraints applied to the Bundle resource by the International Patient Summary (IPS) FHIR Implementation Guide for the Hajj Pilgrimage.

Usage:

Examples for this Resource Profile: Bundle/MyIPS

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from BundleUvIps

Name	Flags	Card.	Type	Description & Constraints
Bundle		0..*	BundleUvIps	International Patient Summary Bundle
entry		3..*	BackboneElement	Entry resource in the patient summary bundle
Slices for entry				Content/Rules for all slices
entry:composition		1..1	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:patient		1..1	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:allergyintolerance		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:condition		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:device		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:deviceusestatement		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:diagnosticreport		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:imagingstudy		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:immunization		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:media		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:medication		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:medicationrequest		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:medicationstatement		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:practitioner		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:practitionerrole		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:procedure		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:organization		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:observation-pregnancy-edd		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:observation-pregnancy-outcome		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:observation-pregnancy-status		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:observation-alcohol-use		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:observation-tobacco-use		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:observation-results		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:specimen		0..*	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	S	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
search		0..0
request		0..0
response		0..0
entry:consent		1..*	BackboneElement	Entry resource in the patient summary bundle
resource		0..1	HajjConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	BundleUvIps	International Patient Summary Bundle 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 bdl-ips-1: An IPS document must have no additional Composition (including Composition subclass) resources besides the first.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
identifier	SΣ	1..1	Identifier	Persistent identifier for the bundle
type	Σ	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. Fixed Value: document
timestamp	SΣ	1..1	instant	When the bundle was assembled
Slices for entry	SΣC	3..*	BackboneElement	Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource, 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)
entry:composition	Σ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	CompositionUvIps	International Patient Summary composition
entry:patient	Σ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	PatientUvIps	Information about an individual or animal receiving health care services
entry:allergyintolerance	Σ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
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	C	1..1	AllergyIntoleranceUvIps	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
entry:condition	Σ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
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	C	1..1	ConditionUvIps	Documentation of a health problem of the patient con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
entry:device	Σ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
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	Device	Item used in healthcare
entry:deviceusestatement	Σ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
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	DeviceUseStatementUvIps	Record of use of a device
entry:diagnosticreport	Σ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
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	DiagnosticReportUvIps	A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:imagingstudy	Σ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
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	ImagingStudyUvIps	A set of images produced in single study (one or more series of references images)
entry:immunization	Σ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
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	ImmunizationUvIps	Immunization event information
entry:media	Σ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
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	MediaObservationUvIps	A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
entry:medication	Σ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
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	MedicationIPS	Definition of a Medication
entry:medicationrequest	Σ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
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	MedicationRequestIPS	Ordering of medication for patient or group
entry:medicationstatement	Σ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
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	MedicationStatementIPS	Record of medication being taken by a patient
entry:practitioner	Σ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
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	PractitionerUvIps	A person with a formal responsibility in the provisioning of healthcare or related services
entry:practitionerrole	Σ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
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	PractitionerRoleUvIps	Roles/organizations the practitioner is associated with
entry:procedure	Σ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
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	ProcedureUvIps	An action that is being or was performed on a patient
entry:organization	Σ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
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	C	1..1	OrganizationUvIps	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
entry:observation-pregnancy-edd	Σ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
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	C	1..1	ObservationPregnancyEddUvIps	Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
entry:observation-pregnancy-outcome	Σ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
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	C	1..1	ObservationPregnancyOutcomeUvIps	Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
entry:observation-pregnancy-status	Σ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
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	C	1..1	ObservationPregnancyStatusUvIps	Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
entry:observation-alcohol-use	Σ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
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	C	1..1	ObservationAlcoholUseUvIps	Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
entry:observation-tobacco-use	Σ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
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	C	1..1	ObservationTobaccoUseUvIps	Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
entry:observation-results	Σ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
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	C	1..1	ObservationResultsUvIps	Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
entry:specimen	Σ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
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	SpecimenUvIps	Sample for analysis
entry:consent	SΣC	1..*	BackboneElement	Entry resource in the patient summary bundle 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		0..1	HajjConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Fixed Value: document `http://hl7.org/fhir/ValueSet/bundle-type\|4.0.1` from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:composition.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:patient.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:allergyintolerance.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:condition.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:device.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:deviceusestatement.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:diagnosticreport.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:imagingstudy.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:immunization.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:media.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:medication.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:medicationrequest.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:medicationstatement.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:practitioner.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:practitionerrole.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:procedure.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:organization.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:observation-pregnancy-edd.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:observation-pregnancy-outcome.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:observation-pregnancy-status.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:observation-alcohol-use.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:observation-tobacco-use.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:observation-results.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:specimen.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard
Bundle.entry:consent.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ait-1	error	Bundle.entry:allergyintolerance.resource	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	Bundle.entry:allergyintolerance.resource	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
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:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation-pregnancy-edd, Bundle.entry:observation-pregnancy-outcome, Bundle.entry:observation-pregnancy-status, Bundle.entry:observation-alcohol-use, Bundle.entry:observation-tobacco-use, Bundle.entry:observation-results, Bundle.entry:specimen, Bundle.entry:consent	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:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation-pregnancy-edd, Bundle.entry:observation-pregnancy-outcome, Bundle.entry:observation-pregnancy-status, Bundle.entry:observation-alcohol-use, Bundle.entry:observation-tobacco-use, Bundle.entry:observation-results, Bundle.entry:specimen, Bundle.entry:consent	fullUrl cannot be a version specific reference : 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)
bdl-ips-1	error	Bundle	An IPS document must have no additional Composition (including Composition subclass) resources besides the first. : entry.tail().where(resource is Composition).empty()
con-3	best practice	Bundle.entry:condition.resource	Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4	error	Bundle.entry:condition.resource	If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5	error	Bundle.entry:condition.resource	Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	Bundle.entry:composition.resource, Bundle.entry:patient.resource, Bundle.entry:allergyintolerance.resource, Bundle.entry:condition.resource, Bundle.entry:device.resource, Bundle.entry:deviceusestatement.resource, Bundle.entry:diagnosticreport.resource, Bundle.entry:imagingstudy.resource, Bundle.entry:immunization.resource, Bundle.entry:media.resource, Bundle.entry:medication.resource, Bundle.entry:medicationrequest.resource, Bundle.entry:medicationstatement.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerrole.resource, Bundle.entry:procedure.resource, Bundle.entry:organization.resource, Bundle.entry:observation-pregnancy-edd.resource, Bundle.entry:observation-pregnancy-outcome.resource, Bundle.entry:observation-pregnancy-status.resource, Bundle.entry:observation-alcohol-use.resource, Bundle.entry:observation-tobacco-use.resource, Bundle.entry:observation-results.resource, Bundle.entry:specimen.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Bundle.entry:composition.resource, Bundle.entry:patient.resource, Bundle.entry:allergyintolerance.resource, Bundle.entry:condition.resource, Bundle.entry:device.resource, Bundle.entry:deviceusestatement.resource, Bundle.entry:diagnosticreport.resource, Bundle.entry:imagingstudy.resource, Bundle.entry:immunization.resource, Bundle.entry:media.resource, Bundle.entry:medication.resource, Bundle.entry:medicationrequest.resource, Bundle.entry:medicationstatement.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerrole.resource, Bundle.entry:procedure.resource, Bundle.entry:organization.resource, Bundle.entry:observation-pregnancy-edd.resource, Bundle.entry:observation-pregnancy-outcome.resource, Bundle.entry:observation-pregnancy-status.resource, Bundle.entry:observation-alcohol-use.resource, Bundle.entry:observation-tobacco-use.resource, Bundle.entry:observation-results.resource, Bundle.entry:specimen.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Bundle.entry:composition.resource, Bundle.entry:patient.resource, Bundle.entry:allergyintolerance.resource, Bundle.entry:condition.resource, Bundle.entry:device.resource, Bundle.entry:deviceusestatement.resource, Bundle.entry:diagnosticreport.resource, Bundle.entry:imagingstudy.resource, Bundle.entry:immunization.resource, Bundle.entry:media.resource, Bundle.entry:medication.resource, Bundle.entry:medicationrequest.resource, Bundle.entry:medicationstatement.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerrole.resource, Bundle.entry:procedure.resource, Bundle.entry:organization.resource, Bundle.entry:observation-pregnancy-edd.resource, Bundle.entry:observation-pregnancy-outcome.resource, Bundle.entry:observation-pregnancy-status.resource, Bundle.entry:observation-alcohol-use.resource, Bundle.entry:observation-tobacco-use.resource, Bundle.entry:observation-results.resource, Bundle.entry:specimen.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Bundle.entry:composition.resource, Bundle.entry:patient.resource, Bundle.entry:allergyintolerance.resource, Bundle.entry:condition.resource, Bundle.entry:device.resource, Bundle.entry:deviceusestatement.resource, Bundle.entry:diagnosticreport.resource, Bundle.entry:imagingstudy.resource, Bundle.entry:immunization.resource, Bundle.entry:media.resource, Bundle.entry:medication.resource, Bundle.entry:medicationrequest.resource, Bundle.entry:medicationstatement.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerrole.resource, Bundle.entry:procedure.resource, Bundle.entry:organization.resource, Bundle.entry:observation-pregnancy-edd.resource, Bundle.entry:observation-pregnancy-outcome.resource, Bundle.entry:observation-pregnancy-status.resource, Bundle.entry:observation-alcohol-use.resource, Bundle.entry:observation-tobacco-use.resource, Bundle.entry:observation-results.resource, Bundle.entry:specimen.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Bundle.entry:composition.resource, Bundle.entry:patient.resource, Bundle.entry:allergyintolerance.resource, Bundle.entry:condition.resource, Bundle.entry:device.resource, Bundle.entry:deviceusestatement.resource, Bundle.entry:diagnosticreport.resource, Bundle.entry:imagingstudy.resource, Bundle.entry:immunization.resource, Bundle.entry:media.resource, Bundle.entry:medication.resource, Bundle.entry:medicationrequest.resource, Bundle.entry:medicationstatement.resource, Bundle.entry:practitioner.resource, Bundle.entry:practitionerrole.resource, Bundle.entry:procedure.resource, Bundle.entry:organization.resource, Bundle.entry:observation-pregnancy-edd.resource, Bundle.entry:observation-pregnancy-outcome.resource, Bundle.entry:observation-pregnancy-status.resource, Bundle.entry:observation-alcohol-use.resource, Bundle.entry:observation-tobacco-use.resource, Bundle.entry:observation-results.resource, Bundle.entry:specimen.resource	A resource should have narrative for robust management : text.`div`.exists()
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()
obs-6	error	Bundle.entry:observation-pregnancy-edd.resource, Bundle.entry:observation-pregnancy-outcome.resource, Bundle.entry:observation-pregnancy-status.resource, Bundle.entry:observation-alcohol-use.resource, Bundle.entry:observation-tobacco-use.resource, Bundle.entry:observation-results.resource	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	error	Bundle.entry:observation-pregnancy-edd.resource, Bundle.entry:observation-pregnancy-outcome.resource, Bundle.entry:observation-pregnancy-status.resource, Bundle.entry:observation-alcohol-use.resource, Bundle.entry:observation-tobacco-use.resource, Bundle.entry:observation-results.resource	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
org-1	error	Bundle.entry:organization.resource	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0

Description & Constraints

Bundle

0..*

BundleUvIps

International Patient Summary Bundle
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
bdl-ips-1: An IPS document must have no additional Composition (including Composition subclass) resources besides the first.

0..1

Logical id of this artifact