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

• Content
• Detailed Descriptions
• Examples
• XML
• JSON

Resource Profile: FHIRDocument

Is based on HL7 International Patient Summary - Bundle (document)

Usage:

• Examples for this Resource Profile: Bundle/ab2539ee-fd55-4abc-9898-d4c1520dd2ba and Bundle/e119d231-def6-43a7-af40-56d7754977bd

Formal Views of Profile Content

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

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

This structure is derived from UKCoreBundle

Name	Flags	Card.	Type	Description & Constraints
Bundle		0..*	UKCoreBundle	Contains a collection of resources
identifier	S	1..1	Identifier	Persistent identifier for the bundle
type		1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document
timestamp	S	1..1	instant	When the bundle was assembled
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	UKCoreBundle	Contains a collection of resources bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-12: A message must have a MessageHeader as the first resource bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-11: A document must have a Composition as the first resource bdl-10: A document must have a date
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
identifier	SΣ	1..1	Identifier	Persistent identifier for the bundle
type	SΣ	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
timestamp	SΣ	1..1	instant	When the bundle was assembled
total	ΣC	0..1	unsignedInt	If search, the total number of matches
entry	SΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-8: fullUrl cannot be a version specific reference bdl-5: must be a resource unless there's a request or response 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
search	ΣC	0..1	BackboneElement	Search related information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
request	ΣC	0..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	string	Status response code (text optional)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Fixed Value: document http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	UKCoreBundle	Contains a collection of resources bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-12: A message must have a MessageHeader as the first resource bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-11: A document must have a Composition as the first resource bdl-10: A document must have a date
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	SΣ	1..1	Identifier	Persistent identifier for the bundle
type	SΣ	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
timestamp	SΣ	1..1	instant	When the bundle was assembled
total	ΣC	0..1	unsignedInt	If search, the total number of matches
link	Σ	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link
entry	SΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-8: fullUrl cannot be a version specific reference bdl-5: must be a resource unless there's a request or response 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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle
search	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	Σ	0..1	code	match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Additional execution information (transaction/batch/history)
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Bundle.type	required	Fixed Value: document http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard

This structure is derived from UKCoreBundle

Summary

Mandatory: 2 elements
Must-Support: 2 elements
Fixed: 1 element

Differential View

This structure is derived from UKCoreBundle

Name	Flags	Card.	Type	Description & Constraints
Bundle		0..*	UKCoreBundle	Contains a collection of resources
identifier	S	1..1	Identifier	Persistent identifier for the bundle
type		1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document
timestamp	S	1..1	instant	When the bundle was assembled
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	UKCoreBundle	Contains a collection of resources bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-12: A message must have a MessageHeader as the first resource bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-11: A document must have a Composition as the first resource bdl-10: A document must have a date
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
identifier	SΣ	1..1	Identifier	Persistent identifier for the bundle
type	SΣ	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
timestamp	SΣ	1..1	instant	When the bundle was assembled
total	ΣC	0..1	unsignedInt	If search, the total number of matches
entry	SΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-8: fullUrl cannot be a version specific reference bdl-5: must be a resource unless there's a request or response 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
search	ΣC	0..1	BackboneElement	Search related information
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
request	ΣC	0..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	string	Status response code (text optional)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Fixed Value: document http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	UKCoreBundle	Contains a collection of resources bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-12: A message must have a MessageHeader as the first resource bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-11: A document must have a Composition as the first resource bdl-10: A document must have a date
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	SΣ	1..1	Identifier	Persistent identifier for the bundle
type	SΣ	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
timestamp	SΣ	1..1	instant	When the bundle was assembled
total	ΣC	0..1	unsignedInt	If search, the total number of matches
link	Σ	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link
entry	SΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information bdl-8: fullUrl cannot be a version specific reference bdl-5: must be a resource unless there's a request or response 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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle
search	ΣC	0..1	BackboneElement	Search related information
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode	Σ	0..1	code	match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
score	Σ	0..1	decimal	Search ranking (between 0 and 1)
request	ΣC	0..1	BackboneElement	Additional execution information (transaction/batch/history)
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
method	Σ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
url	Σ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Σ	0..1	string	For managing cache currency
ifModifiedSince	Σ	0..1	instant	For managing cache currency
ifMatch	Σ	0..1	string	For managing update contention
ifNoneExist	Σ	0..1	string	For conditional creates
response	ΣC	0..1	BackboneElement	Results of execution (transaction/batch/history)
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	string	Status response code (text optional)
location	Σ	0..1	uri	The location (if the operation returns a location)
etag	Σ	0..1	string	The Etag for the resource (if relevant)
lastModified	Σ	0..1	instant	Server's date time modified
outcome	Σ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Bundle.type	required	Fixed Value: document http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard

This structure is derived from UKCoreBundle

Summary

Mandatory: 2 elements
Must-Support: 2 elements
Fixed: 1 element

Other representations of profile: CSV, Excel, Schematron