ITK - Document Reference

ITK-Document-Bundle-1

The ITK-Document-Bundle-1 bundle profile is used in the ITK Document Reference interface as a container to collect the following profiles:

  • ITK-DocumentReference-1 An NHS Digital DocumentReference profile used to carry base64 encoded binary content defined by a format other than FHIR, for example a PDF file or an image file. This encoded content must be included in the message bundle.
  • ITK-Binary-1 An NHS Digital profile which stores a health or social care document in a base64 binary format.
  • CareConnect-Patient-1 A CareConnect profile which carries the patient demographic details.
  • CareConnect-Practitioner-1 A CareConnect profile which carries information about the healthcare professional.
  • ITK-RelatedPerson-1 An NHS Digital profile which carries information about a person with a relationship to the patient.
  • CareConnect-ITK-Encounter-1 An NHS Digital profile which carries information about an encounter between a care professional and the patient (or patient's record).
  • CareConnect-Organization-1 A CareConnect profile which carries details of an Organization such as a company, institution, corporation, department, community group or healthcare practice group.
  • CareConnect-Location-1 An CareConnect profile which carries details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
  • ITK-Device-1 An NHS Digital profile which identifies an instance of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

Example

The following xml bundle example contains an instance of a DocumentReference resource and has been converted to a txt file to allow better viewing within a web browser; an xml copy is available within the examples folder in this specification.

This is an example of a document Bundle ITK-Bundle-Example-1.txt

NameCard.TypeDescription & Constraints
..BundleBundleA Bundle resource constrained to represent a container to collect a combination of the ITK Document resources.

...id0..1IdLogical id of this artifact

...meta0..1MetaMetadata about the resource

...implicitRules0..1UriA set of rules under which this content was created

...language0..1CodeLanguage of the resource content
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

...type1..1CodeBundle identified by bundle type 'document'
Binding Indicates the purpose of a bundle - how it was intended to be used (http://hl7.org/fhir/DSTU2/valueset-bundle-type.html)
Binding Strength Required
Fixed Value document

...entry1..*BackboneElementEntry in the bundle - will have a resource, or information

....id0..1Idxml:id (or equivalent in JSON)

....fullUrl0..1UriURL for resource (server address, or UUID/OID)

....resource1..1ResourceResources in this bundle

.....id0..1IdLogical id of this artifact

.....meta0..1MetaMetadata about the resource

.....implicitRules0..1UriA set of rules under which this content was created

.....language0..1CodeLanguage of the resource content
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

Path Name Binding Strength ValueSet
.Bundle.language language Required http://tools.ietf.org/html/bcp47
.Bundle.type type Required http://hl7.org/fhir/DSTU2/valueset-bundle-type.html
.Bundle.entry.search.mode mode Required http://hl7.org/fhir/DSTU2/valueset-search-entry-mode.html
.Bundle.entry.request.method method Required http://hl7.org/fhir/DSTU2/valueset-http-verb.html
.Bundle.signature.type type Preferred http://hl7.org/fhir/DSTU2/valueset-signature-type.html
.Bundle.signature.contentType contentType Required http://www.rfc-editor.org/bcp/bcp13.txt

ITK-Document-Bundle-1

Examples Description XML File
ITK-Bundle-Example-1 Example bundle for ITK document header