ITK - Document Reference

ITK-DocumentReference-1

This constrained FHIR DocumentReference resource is used for general references to pre-existing documents which are not authored and assembled in FHIR. The Binary Resource is referenced within DocumentReference and is used to carry the actual embedded document.

NameCard.TypeDescription & Constraints
..DocumentReferenceDocumentReferenceA reference to a document

...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

...text0..1NarrativeText summary of the resource, for human interpretation

...contained0..*ResourceContained, inline Resources

...dataEnterer0..1ExtensionThe Data Enterer Extension references the Data Enterer or transcriptionist for this document.
Extension https://fhir.nhs.uk/StructureDefinition/Extension-ITK-DataEnterer-1

...informant0..*ExtensionThe Informant Extension references one or more people who informed the author about information contained in the document.
Extension https://fhir.nhs.uk/StructureDefinition/Extension-ITK-Informant-1

...informationRecipient0..*ExtensionThe Information Recipient Extension references the primary information recipient(s) of the document who is/are usually expected to perform some action on receipt of a document.
Extension https://fhir.nhs.uk/StructureDefinition/Extension-ITK-InformationRecipient-1

...participant0..*ExtensionAn extension carrying details of a person or people related to the patient who is/are involved in some way in the document.
Extension https://fhir.nhs.uk/StructureDefinition/Extension-ITK-Participant-1

...performer0..*ExtensionThe Performer Extension carries information about an individual or individuals who perform(s) one or multiple action(s) described in the document.
Extension https://fhir.nhs.uk/StructureDefinition/Extension-ITK-Performer-1

...authorization0..*ExtensionThe Authorisation Extension carries information about an individual or individuals who have overall responsibility for the document.
Extension https://fhir.nhs.uk/StructureDefinition/Extension-ITK-Authorization-1

...careSettingType0..1ExtensionThe Care Setting Type Extension carries details of the Correspondence Care Setting Type.
Extension https://fhir.nhs.uk/StructureDefinition/Extension-ITK-CareSettingType-1

...masterIdentifier0..1IdentifierMaster Version Specific Identifier

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

....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/DSTU2/valueset-identifier-use.html)
Binding Strength Required

....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/DSTU2/valueset-identifier-type.html)
Binding Strength Extensible

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

.....coding0..*CodingCode defined by a terminology system

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

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....system0..1UriThe namespace for the identifier
Example Value http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri

....value1..1StringThe value that is unique

....period0..1PeriodTime period when id is/was valid for use

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

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....assigner0..1Reference (CareConnect-Organization-1)Organization that issued id (may be just text)

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

.....reference1..1StringRelative, internal or absolute URL reference

.....display0..1StringText alternative for the resource

...identifier0..1IdentifierOther identifiers for the document

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

....value1..1StringThe value that is unique

...subject1..1Reference (CareConnect-Patient-1)Who/what is the subject of the document

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

....reference1..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...type1..1CodeableConceptA set of codes to classify the Correspondence document type
Binding Correspondence document type (https://fhir.nhs.uk/ValueSet/DocumentType-1)
Binding Strength Preferred

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

....coding1..1CodingCode defined by a terminology system

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

.....system1..1UriIdentity of the terminology system

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

...author1..*Reference (CareConnect-Practitioner-1 | ITK-Device-1)Who and/or what authored the document

...custodian1..1Reference (CareConnect-Organization-1)Organization which maintains the document

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

....reference1..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...authenticator0..1Reference (CareConnect-Practitioner-1)Who/what authenticated the document

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

....reference1..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...created0..1DateTimeDocument creation time

...indexed1..1InstantWhen this document reference created

...status1..1Codecurrent | superseded | entered-in-error
Binding The status of the document reference. (http://hl7.org/fhir/DSTU2/valueset-document-reference-status.html)
Binding Strength Required

...docStatus0..1CodeableConceptpreliminary | final | appended | amended | entered-in-error
Binding The workflow status of the underlying document. (http://hl7.org/fhir/DSTU2/valueset-composition-status.html)
Binding Strength Required

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

....coding1..1CodingCode defined by a terminology system

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

.....system1..1UriIdentity of the terminology system
Fixed Value http://hl7.org/fhir/composition-status

.....version0..1StringVersion of the system - if relevant

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

.....userSelected0..1BooleanIf this coding was chosen directly by the user

....text0..1StringPlain text representation of the concept

...description0..1StringHuman-readable description (title)

...content1..*BackboneElementDocument referenced

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

....attachment1..1AttachmentWhere to access the document

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

.....contentType0..1CodeMime type of the content, with charset etc.
Binding The mime type of an attachment. Any valid mime type is allowed. (http://www.rfc-editor.org/bcp/bcp13.txt)
Binding Strength Required
Example Value application/pdf

.....language0..1CodeHuman language of the content (BCP-47)
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

.....url1..1UriUri where the data can be found
Example Value urn:uuid:1868a8af-feaf-4f11-90d1-66da928d6bbc

.....hash0..1Base64BinaryHash of the data (sha-1, base64ed)

.....title0..1StringLabel to display in place of the data
Example Value Allied health professional assessment record (record artifact)

.....creation0..1DateTimeDate attachment was first created

...context0..1BackboneElementClinical context of document

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

....encounter0..1Reference (CareConnect-ITK-Encounter-1)Context of the document content

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

.....reference1..1StringRelative, internal or absolute URL reference

.....display0..1StringText alternative for the resource

....period0..1PeriodTime of service that is being documented

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

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

Name Type Description & Constraints
. . Extension-ITK-DataEnterer-1 Extension Extension for ITK data enterer (transcriptionist).
. . Extension-ITK-Informant-1 Extension Extension for ITK informant.
. . Extension-ITK-InformationRecipient-1 Extension Extension for the primary information recipient(s) of the document who are usually expected to perform some action on receipt of it..
. . Extension-ITK-Participant-1 Extension Extension for ITK participant .
. . Extension-ITK-Performer-1 Extension Extension for ITK performer.
. . Extension-ITK-Authorization-1 Extension The Authorisation Extension carries information about an individual or individuals who have overall responsibility for the document.
. . Extension-ITK-CareSettingType-1 Extension Extension for a Care Setting.
Path Name Binding Strength ValueSet
.DocumentReference.language language Required http://tools.ietf.org/html/bcp47
.DocumentReference.masterIdentifier.use use Required http://hl7.org/fhir/DSTU2/valueset-identifier-use.html
.DocumentReference.masterIdentifier.type type Extensible http://hl7.org/fhir/DSTU2/valueset-identifier-type.html
.DocumentReference.type type Preferred https://fhir.nhs.uk/ValueSet/DocumentType-1
.DocumentReference.status status Required http://hl7.org/fhir/DSTU2/valueset-document-reference-status.html
.DocumentReference.docStatus docStatus Required http://hl7.org/fhir/DSTU2/valueset-composition-status.html
.DocumentReference.relatesTo.code code Required http://hl7.org/fhir/DSTU2/valueset-document-relationship-type.html
.DocumentReference.content.attachment.contentType contentType Required http://www.rfc-editor.org/bcp/bcp13.txt