FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.7.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: NZPS-Bundle

This profile represents the constraints applied to the Bundle resource for the New Zealand Patient summary and is based on the profile for the International Patient Summary (IPS) Document Bundle.

Usages:

• Examples for this Profile: Bundle/IosefaFuimaono-Bundle and Bundle/NZPSNoClinicalInfoBundle

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	BundleUvIps	International Patient Summary Bundle Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-ips-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
identifier	SOΣ	1..1	Identifier	Persistent identifier for the bundle Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS)
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	SOΣ	1..1	instant	When the bundle was assembled Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS)
Slices for entry	ΣC	2..*	BackboneElement	Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
entry:composition	SOΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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 Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS) SHOULD:display Consumer (IPS) from Bundle (IPS)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSComposition	International Patient Summary composition
entry:patient	ΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPatient	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSAllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
entry:careplan	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	NZPSCarePlan	Healthcare plan for patient or group
entry:clinicalimpression	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	NZPSClinicalImpression	A clinical assessment performed when planning treatments and management strategies for a patient
entry:condition	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSProblem	Documentation of a health problem of the patient
entry:consent	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	Consent	A resource in the bundle
entry:device	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	Device	A resource in the bundle
entry:deviceusestatement	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSDiagnosticReport	A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:documentreference	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	DocumentReference	A resource in the bundle
entry:flag	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	FlagAlertUvIps	Key information to flag to healthcare providers
entry:imagingstudy	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSImmunization	Immunization event information
entry:immunizationrecommendation	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	ImmunizationRecommendation	A resource in the bundle
entry:medication	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedication	Definition of a Medication
entry:medicationrequest	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedicationRequest	Ordering of medication for patient or group
entry:medicationstatement	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedicationStatement	Record of medication being taken by a patient
entry:practitioner	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPractitioner	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPractitionerRole	Roles/organizations the practitioner is associated with
entry:procedure	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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:observation-pregnancy-edd	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyEddUvIps	Measurements and simple assertions
entry:observation-pregnancy-outcome	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyOutcomeUvIps	Measurements and simple assertions
entry:observation-pregnancy-status	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyStatusUvIps	Measurements and simple assertions
entry:observation-alcohol-use	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationAlcoholUseUvIps	Measurements and simple assertions
entry:observation-tobacco-use	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationSmokingStatus	Measurements and simple assertions
entry:observation-results-laboratory-pathology	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationResultsLaboratoryPathology	Laboratory (including Pathology) result for a simple test or for a panel/study
entry:observation-results-radiology	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationResultsRadiologyUvIps	Measurements and simple assertions
entry:observation-vital-signs	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationVitalSigns	FHIR Vital Signs Profile
entry:organization	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSOrganization	A grouping of people or organizations with a common purpose
entry:specimen	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	SpecimenUvIps	Sample for analysis
entry:communication	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSCommunication	A record of information transmitted from a sender to a receiver
entry:encounter	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSEncounter	An interaction during which services are provided to the patient
entry:observation-vaping-use	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSObservationVapingStatus	Measurements and simple assertions
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.type	Base	required	BundleType	📍4.0.1	FHIR Std.
Bundle.entry.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:composition.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:patient.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:allergyintolerance.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:careplan.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:clinicalimpression.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:condition.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:consent.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:device.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:deviceusestatement.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:diagnosticreport.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:documentreference.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:flag.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:imagingstudy.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:immunization.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:immunizationrecommendation.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medication.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationstatement.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitionerrole.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:procedure.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-edd.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-status.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-alcohol-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-tobacco-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-laboratory-pathology.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-radiology.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-vital-signs.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:organization.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:specimen.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:communication.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:encounter.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-vaping-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen, Bundle.entry:communication, Bundle.entry:encounter, Bundle.entry:observation-vaping-use	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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen, Bundle.entry:communication, Bundle.entry:encounter, Bundle.entry:observation-vaping-use	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()
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()

This structure is derived from BundleUvIps

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle		0..*	BundleUvIps	International 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
resource		1..1	NZPSComposition	International Patient Summary composition
entry:patient		1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSPatient	Information about an individual or animal receiving health care services
entry:allergyintolerance		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSAllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
entry:careplan		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSCarePlan	Healthcare plan for patient or group
entry:clinicalimpression		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSClinicalImpression	A clinical assessment performed when planning treatments and management strategies for a patient
entry:condition		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSProblem	Documentation of a health problem of the patient
entry:diagnosticreport		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSDiagnosticReport	A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:immunization		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSImmunization	Immunization event information
entry:medication		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSMedication	Definition of a Medication
entry:medicationrequest		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSMedicationRequest	Ordering of medication for patient or group
entry:medicationstatement		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSMedicationStatement	Record of medication being taken by a patient
entry:practitioner		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
entry:practitionerrole		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSPractitionerRole	Roles/organizations the practitioner is associated with
entry:observation-tobacco-use		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSObservationSmokingStatus	Measurements and simple assertions
entry:observation-results-laboratory-pathology		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSObservationResultsLaboratoryPathology	Laboratory (including Pathology) result for a simple test or for a panel/study
entry:observation-vital-signs		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSObservationVitalSigns	FHIR Vital Signs Profile
entry:organization		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSOrganization	A grouping of people or organizations with a common purpose
entry:communication		0..*	BackboneElement	Entry resource in the patient summary bundle
resource		0..1	NZPSCommunication	A record of information transmitted from a sender to a receiver
entry:encounter		0..*	BackboneElement	Entry resource in the patient summary bundle
resource		0..1	NZPSEncounter	An interaction during which services are provided to the patient
entry:observation-vaping-use		0..*	BackboneElement	Entry resource in the patient summary bundle
resource		0..1	NZPSObservationVapingStatus	Measurements and simple assertions
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	BundleUvIps	International Patient Summary Bundle Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-ips-1
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): A human language. Additional Bindings Purpose AllLanguages Max Binding
identifier	SOΣ	1..1	Identifier	Persistent identifier for the bundle Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS)
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	SOΣ	1..1	instant	When the bundle was assembled Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS)
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	2..*	BackboneElement	Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle
entry:composition	SOΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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 Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS) SHOULD:display Consumer (IPS) from Bundle (IPS)
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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSComposition	International Patient Summary composition
entry:patient	ΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPatient	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSAllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
entry:careplan	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	NZPSCarePlan	Healthcare plan for patient or group
entry:clinicalimpression	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	NZPSClinicalImpression	A clinical assessment performed when planning treatments and management strategies for a patient
entry:condition	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSProblem	Documentation of a health problem of the patient
entry:consent	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	Consent	A resource in the bundle
entry:device	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	Device	A resource in the bundle
entry:deviceusestatement	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSDiagnosticReport	A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:documentreference	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	DocumentReference	A resource in the bundle
entry:flag	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	FlagAlertUvIps	Key information to flag to healthcare providers
entry:imagingstudy	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSImmunization	Immunization event information
entry:immunizationrecommendation	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	ImmunizationRecommendation	A resource in the bundle
entry:medication	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedication	Definition of a Medication
entry:medicationrequest	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedicationRequest	Ordering of medication for patient or group
entry:medicationstatement	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedicationStatement	Record of medication being taken by a patient
entry:practitioner	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPractitioner	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPractitionerRole	Roles/organizations the practitioner is associated with
entry:procedure	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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:observation-pregnancy-edd	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyEddUvIps	Measurements and simple assertions
entry:observation-pregnancy-outcome	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyOutcomeUvIps	Measurements and simple assertions
entry:observation-pregnancy-status	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyStatusUvIps	Measurements and simple assertions
entry:observation-alcohol-use	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationAlcoholUseUvIps	Measurements and simple assertions
entry:observation-tobacco-use	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationSmokingStatus	Measurements and simple assertions
entry:observation-results-laboratory-pathology	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationResultsLaboratoryPathology	Laboratory (including Pathology) result for a simple test or for a panel/study
entry:observation-results-radiology	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationResultsRadiologyUvIps	Measurements and simple assertions
entry:observation-vital-signs	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationVitalSigns	FHIR Vital Signs Profile
entry:organization	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSOrganization	A grouping of people or organizations with a common purpose
entry:specimen	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	SpecimenUvIps	Sample for analysis
entry:communication	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSCommunication	A record of information transmitted from a sender to a receiver
entry:encounter	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSEncounter	An interaction during which services are provided to the patient
entry:observation-vaping-use	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSObservationVapingStatus	Measurements and simple assertions
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Bundle.type	Base	required	BundleType	📍4.0.1	FHIR Std.
Bundle.entry.search.​mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:composition.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:composition.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:patient.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:patient.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:allergyintolerance.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:allergyintolerance.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:careplan.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:careplan.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:clinicalimpression.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:clinicalimpression.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:condition.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:condition.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:consent.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:consent.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:device.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:device.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:deviceusestatement.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:deviceusestatement.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:diagnosticreport.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:diagnosticreport.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:documentreference.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:documentreference.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:flag.search.​mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:flag.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:imagingstudy.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:imagingstudy.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:immunization.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:immunization.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:immunizationrecommendation.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:immunizationrecommendation.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medication.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:medication.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationstatement.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:medicationstatement.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitionerrole.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:practitionerrole.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:procedure.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:procedure.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-edd.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-edd.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-status.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-status.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-alcohol-use.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-alcohol-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-tobacco-use.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-tobacco-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-laboratory-pathology.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-laboratory-pathology.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-radiology.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-radiology.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-vital-signs.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-vital-signs.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:organization.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:organization.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:specimen.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:specimen.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:communication.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:communication.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:encounter.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:encounter.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-vaping-use.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-vaping-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen, Bundle.entry:communication, Bundle.entry:encounter, Bundle.entry:observation-vaping-use	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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen, Bundle.entry:communication, Bundle.entry:encounter, Bundle.entry:observation-vaping-use	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()
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()

This structure is derived from BundleUvIps

Summary

Structures

This structure refers to these other structures:

• NZPS-Composition (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-composition)
• NZPS-Patient (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-patient)
• NZPS-AllergyIntolerance (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-allergyintolerance)
• NZPS-CarePlan (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-care-plan)
• NZPS-Clinical-Impression (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-clinical-impression)
• NZPS-Problem (Condition) (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-problem)
• NZPS-DiagnosticReport (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-diagnostic-report)
• NZPS-Immunization (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-immunization)
• NZPS-Medication (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medication)
• NZPS-MedicationRequest (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medicationrequest)
• NZPS-MedicationStatement (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medicationstatement)
• NZPS-Practitioner (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-ppractitioner)
• NZPS-PractitionerRole (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-ppractitionerRole)
• NZPS-Observation-Smoking-Status (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-observation-smokingstatus)
• NZPS-Observation-Results-Laboratory-Pathology (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-observation-results-laboratory-pathology)
• NZPS-Observation-Vital-Signs (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-observation-vitalsigns)
• NZPS-Organization (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/NZPS-organization)
• NZPS-Communication (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-communication)
• NZPS-Encounter (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-encounter)
• NZPS-Observation-Vaping-Status (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-observation-vapingstatus)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	BundleUvIps	International Patient Summary Bundle Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-ips-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
identifier	SOΣ	1..1	Identifier	Persistent identifier for the bundle Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS)
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	SOΣ	1..1	instant	When the bundle was assembled Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS)
Slices for entry	ΣC	2..*	BackboneElement	Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
entry:composition	SOΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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 Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS) SHOULD:display Consumer (IPS) from Bundle (IPS)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSComposition	International Patient Summary composition
entry:patient	ΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPatient	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSAllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
entry:careplan	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	NZPSCarePlan	Healthcare plan for patient or group
entry:clinicalimpression	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	NZPSClinicalImpression	A clinical assessment performed when planning treatments and management strategies for a patient
entry:condition	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSProblem	Documentation of a health problem of the patient
entry:consent	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	Consent	A resource in the bundle
entry:device	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	Device	A resource in the bundle
entry:deviceusestatement	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSDiagnosticReport	A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:documentreference	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	DocumentReference	A resource in the bundle
entry:flag	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	FlagAlertUvIps	Key information to flag to healthcare providers
entry:imagingstudy	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSImmunization	Immunization event information
entry:immunizationrecommendation	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	ImmunizationRecommendation	A resource in the bundle
entry:medication	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedication	Definition of a Medication
entry:medicationrequest	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedicationRequest	Ordering of medication for patient or group
entry:medicationstatement	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedicationStatement	Record of medication being taken by a patient
entry:practitioner	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPractitioner	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPractitionerRole	Roles/organizations the practitioner is associated with
entry:procedure	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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:observation-pregnancy-edd	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyEddUvIps	Measurements and simple assertions
entry:observation-pregnancy-outcome	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyOutcomeUvIps	Measurements and simple assertions
entry:observation-pregnancy-status	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyStatusUvIps	Measurements and simple assertions
entry:observation-alcohol-use	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationAlcoholUseUvIps	Measurements and simple assertions
entry:observation-tobacco-use	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationSmokingStatus	Measurements and simple assertions
entry:observation-results-laboratory-pathology	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationResultsLaboratoryPathology	Laboratory (including Pathology) result for a simple test or for a panel/study
entry:observation-results-radiology	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationResultsRadiologyUvIps	Measurements and simple assertions
entry:observation-vital-signs	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationVitalSigns	FHIR Vital Signs Profile
entry:organization	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSOrganization	A grouping of people or organizations with a common purpose
entry:specimen	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	SpecimenUvIps	Sample for analysis
entry:communication	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSCommunication	A record of information transmitted from a sender to a receiver
entry:encounter	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSEncounter	An interaction during which services are provided to the patient
entry:observation-vaping-use	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSObservationVapingStatus	Measurements and simple assertions
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.type	Base	required	BundleType	📍4.0.1	FHIR Std.
Bundle.entry.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:composition.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:patient.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:allergyintolerance.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:careplan.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:clinicalimpression.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:condition.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:consent.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:device.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:deviceusestatement.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:diagnosticreport.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:documentreference.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:flag.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:imagingstudy.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:immunization.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:immunizationrecommendation.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medication.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationstatement.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitionerrole.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:procedure.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-edd.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-status.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-alcohol-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-tobacco-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-laboratory-pathology.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-radiology.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-vital-signs.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:organization.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:specimen.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:communication.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:encounter.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-vaping-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen, Bundle.entry:communication, Bundle.entry:encounter, Bundle.entry:observation-vaping-use	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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen, Bundle.entry:communication, Bundle.entry:encounter, Bundle.entry:observation-vaping-use	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()
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()

Differential View

This structure is derived from BundleUvIps

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle		0..*	BundleUvIps	International 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
resource		1..1	NZPSComposition	International Patient Summary composition
entry:patient		1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSPatient	Information about an individual or animal receiving health care services
entry:allergyintolerance		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSAllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
entry:careplan		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSCarePlan	Healthcare plan for patient or group
entry:clinicalimpression		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSClinicalImpression	A clinical assessment performed when planning treatments and management strategies for a patient
entry:condition		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSProblem	Documentation of a health problem of the patient
entry:diagnosticreport		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSDiagnosticReport	A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:immunization		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSImmunization	Immunization event information
entry:medication		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSMedication	Definition of a Medication
entry:medicationrequest		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSMedicationRequest	Ordering of medication for patient or group
entry:medicationstatement		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSMedicationStatement	Record of medication being taken by a patient
entry:practitioner		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
entry:practitionerrole		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSPractitionerRole	Roles/organizations the practitioner is associated with
entry:observation-tobacco-use		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSObservationSmokingStatus	Measurements and simple assertions
entry:observation-results-laboratory-pathology		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSObservationResultsLaboratoryPathology	Laboratory (including Pathology) result for a simple test or for a panel/study
entry:observation-vital-signs		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSObservationVitalSigns	FHIR Vital Signs Profile
entry:organization		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	NZPSOrganization	A grouping of people or organizations with a common purpose
entry:communication		0..*	BackboneElement	Entry resource in the patient summary bundle
resource		0..1	NZPSCommunication	A record of information transmitted from a sender to a receiver
entry:encounter		0..*	BackboneElement	Entry resource in the patient summary bundle
resource		0..1	NZPSEncounter	An interaction during which services are provided to the patient
entry:observation-vaping-use		0..*	BackboneElement	Entry resource in the patient summary bundle
resource		0..1	NZPSObservationVapingStatus	Measurements and simple assertions
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	BundleUvIps	International Patient Summary Bundle Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-ips-1
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): A human language. Additional Bindings Purpose AllLanguages Max Binding
identifier	SOΣ	1..1	Identifier	Persistent identifier for the bundle Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS)
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	SOΣ	1..1	instant	When the bundle was assembled Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS)
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	2..*	BackboneElement	Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle
entry:composition	SOΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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 Obligations Actor Source SHALL:populate Creator (IPS) from Bundle (IPS) SHALL:handle Consumer (IPS) from Bundle (IPS) SHOULD:display Consumer (IPS) from Bundle (IPS)
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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSComposition	International Patient Summary composition
entry:patient	ΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPatient	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSAllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
entry:careplan	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	NZPSCarePlan	Healthcare plan for patient or group
entry:clinicalimpression	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	NZPSClinicalImpression	A clinical assessment performed when planning treatments and management strategies for a patient
entry:condition	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSProblem	Documentation of a health problem of the patient
entry:consent	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	Consent	A resource in the bundle
entry:device	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	Device	A resource in the bundle
entry:deviceusestatement	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSDiagnosticReport	A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:documentreference	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	DocumentReference	A resource in the bundle
entry:flag	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	FlagAlertUvIps	Key information to flag to healthcare providers
entry:imagingstudy	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSImmunization	Immunization event information
entry:immunizationrecommendation	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	ImmunizationRecommendation	A resource in the bundle
entry:medication	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedication	Definition of a Medication
entry:medicationrequest	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedicationRequest	Ordering of medication for patient or group
entry:medicationstatement	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSMedicationStatement	Record of medication being taken by a patient
entry:practitioner	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPractitioner	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 Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSPractitionerRole	Roles/organizations the practitioner is associated with
entry:procedure	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	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:observation-pregnancy-edd	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyEddUvIps	Measurements and simple assertions
entry:observation-pregnancy-outcome	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyOutcomeUvIps	Measurements and simple assertions
entry:observation-pregnancy-status	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationPregnancyStatusUvIps	Measurements and simple assertions
entry:observation-alcohol-use	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationAlcoholUseUvIps	Measurements and simple assertions
entry:observation-tobacco-use	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationSmokingStatus	Measurements and simple assertions
entry:observation-results-laboratory-pathology	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationResultsLaboratoryPathology	Laboratory (including Pathology) result for a simple test or for a panel/study
entry:observation-results-radiology	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	ObservationResultsRadiologyUvIps	Measurements and simple assertions
entry:observation-vital-signs	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSObservationVitalSigns	FHIR Vital Signs Profile
entry:organization	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	NZPSOrganization	A grouping of people or organizations with a common purpose
entry:specimen	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	SpecimenUvIps	Sample for analysis
entry:communication	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSCommunication	A record of information transmitted from a sender to a receiver
entry:encounter	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSEncounter	An interaction during which services are provided to the patient
entry:observation-vaping-use	ΣC	0..*	BackboneElement	Entry resource in the patient summary bundle Constraints: bdl-5, bdl-8 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	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		0..1	NZPSObservationVapingStatus	Measurements and simple assertions
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Bundle.type	Base	required	BundleType	📍4.0.1	FHIR Std.
Bundle.entry.search.​mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:composition.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:composition.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:patient.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:patient.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:allergyintolerance.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:allergyintolerance.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:careplan.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:careplan.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:clinicalimpression.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:clinicalimpression.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:condition.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:condition.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:consent.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:consent.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:device.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:device.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:deviceusestatement.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:deviceusestatement.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:diagnosticreport.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:diagnosticreport.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:documentreference.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:documentreference.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:flag.search.​mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:flag.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:imagingstudy.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:imagingstudy.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:immunization.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:immunization.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:immunizationrecommendation.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:immunizationrecommendation.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medication.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:medication.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationstatement.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:medicationstatement.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitionerrole.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:practitionerrole.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:procedure.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:procedure.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-edd.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-edd.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-status.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-pregnancy-status.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-alcohol-use.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-alcohol-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-tobacco-use.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-tobacco-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-laboratory-pathology.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-laboratory-pathology.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-radiology.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-results-radiology.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-vital-signs.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-vital-signs.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:organization.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:organization.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:specimen.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:specimen.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:communication.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:communication.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:encounter.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:encounter.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:observation-vaping-use.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:observation-vaping-use.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen, Bundle.entry:communication, Bundle.entry:encounter, Bundle.entry:observation-vaping-use	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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen, Bundle.entry:communication, Bundle.entry:encounter, Bundle.entry:observation-vaping-use	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()
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()

This structure is derived from BundleUvIps

Summary

Structures

This structure refers to these other structures:

• NZPS-Composition (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-composition)
• NZPS-Patient (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-patient)
• NZPS-AllergyIntolerance (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-allergyintolerance)
• NZPS-CarePlan (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-care-plan)
• NZPS-Clinical-Impression (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-clinical-impression)
• NZPS-Problem (Condition) (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-problem)
• NZPS-DiagnosticReport (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-diagnostic-report)
• NZPS-Immunization (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-immunization)
• NZPS-Medication (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medication)
• NZPS-MedicationRequest (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medicationrequest)
• NZPS-MedicationStatement (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medicationstatement)
• NZPS-Practitioner (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-ppractitioner)
• NZPS-PractitionerRole (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-ppractitionerRole)
• NZPS-Observation-Smoking-Status (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-observation-smokingstatus)
• NZPS-Observation-Results-Laboratory-Pathology (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-observation-results-laboratory-pathology)
• NZPS-Observation-Vital-Signs (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-observation-vitalsigns)
• NZPS-Organization (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/NZPS-organization)
• NZPS-Communication (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-communication)
• NZPS-Encounter (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-encounter)
• NZPS-Observation-Vaping-Status (https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-observation-vapingstatus)