2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: DocumentReference

The official URL for this profile is: 

http://hl7.org/fhir/Profile/xds-documentreference

. XDSDocumentEntry

This profile was published on Sun, Jun 24, 2012 00:00+1000 as a draft by HL7.

Summary

Required/Prohibited Elements

  • The element DocumentReference is required
  • The element DocumentReference.masterIdentifier is required
  • The element DocumentReference.subject is required
  • The element DocumentReference.type is required
  • The element DocumentReference.class is required
  • The element DocumentReference.format is required
  • The element DocumentReference.author is required
  • The element DocumentReference.custodian is prohibited
  • The element DocumentReference.created is required
  • The element DocumentReference.indexed is required
  • The element DocumentReference.status is required
  • The element DocumentReference.docStatus is prohibited
  • The element DocumentReference.relatesTo.code is required
  • The element DocumentReference.relatesTo.target is required
  • The element DocumentReference.confidentiality is required
  • The element DocumentReference.content.contentType is required
  • The element DocumentReference.context.period is required

Formal Views of Profile Content

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

Differential View

This structure is derived from DocumentReference.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 1..1XDSDocumentEntry
... masterIdentifier 1..1IdentifierXDSDocumentEntry.uniqueId
... identifier 0..*IdentifierXDSDocumentEntry.referenceIdList
... subject 1..1PatientXDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo
... type 1..1CodeableConceptXDSDocumentEntry.typeCode
... class 1..1CodeableConceptXDSDocumentEntry.classCode
... format 1..1uriXDSDocumentEntry.formatCode
... author 1..*Practitioner, DeviceXDSDocumentEntry.author
... custodian 0..0Organization
... policyManager 0..1uriXDSDocumentEntry.homeCommunityId
... authenticator 0..1Practitioner??
... created 1..1dateTimeXDSDocumentEntry.creationTime
... indexed 1..1instantXDS submission time or XDSDocumentEntry.creationTime if unknown
... status 1..1codeimplied by XDS workflow
... docStatus 0..0CodeableConcept
... relatesTo 0..*Relationships that this document has with other document references that already exist
.... code 1..1codeThe type of relationship that this document has with anther document
.... target 1..1DocumentReferenceThe target document of this relationship
... description 0..1stringXDSDocumentEntry.title
... confidentiality 1..1CodeableConceptXDSDocumentEntry.confidentialityCode
... content
.... contentType 1..1codeXDSDocumentEntry.mimeType
.... language 0..1codeXDSDocumentEntry.languageCode
.... url 0..1urirepository location (by implication & configuration)
.... size 0..1integerXDSDocumentEntry.size
.... hash 0..1base64BinaryXDSDocumentEntry.hash
... context 0..1event codes, service Start & Stop time, and facility type
.... event 0..*CodeableConceptXDSDocumentEntry.eventCodeList
.... period 1..1PeriodXDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime
.... facilityType 0..1CodeableConceptXDSDocumentEntry.healthCareFacilityTypeCode

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 1..1XDSDocumentEntry
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... masterIdentifier 1..1IdentifierXDSDocumentEntry.uniqueId
... identifier 0..*IdentifierXDSDocumentEntry.referenceIdList
... subject 1..1PatientXDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo
... type 1..1CodeableConceptXDSDocumentEntry.typeCode
Binding: DocumentType (preferred, extensible)
... class 1..1CodeableConceptXDSDocumentEntry.classCode
Binding: DocumentClass (example, extensible)
... format 1..1uriXDSDocumentEntry.formatCode
... author 1..*Practitioner, DeviceXDSDocumentEntry.author
... policyManager 0..1uriXDSDocumentEntry.homeCommunityId
... authenticator 0..1Practitioner??
... created 1..1dateTimeXDSDocumentEntry.creationTime
... indexed 1..1instantXDS submission time or XDSDocumentEntry.creationTime if unknown
... status M1..1codeimplied by XDS workflow
Binding: DocumentReferenceStatus (required, not extensible)
... relatesTo M0..*Relationships that this document has with other document references that already exist
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... code 1..1codeThe type of relationship that this document has with anther document
Binding: DocumentRelationshipType (required, not extensible)
.... target 1..1DocumentReferenceThe target document of this relationship
... description 0..1stringXDSDocumentEntry.title
... confidentiality M1..1CodeableConceptXDSDocumentEntry.confidentialityCode
Binding: DocumentConfidentiality (preferred, extensible)
... content 1..*AttachmentWhere to access the document
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... contentType 1..1codeXDSDocumentEntry.mimeType
Binding: MimeType (required, not extensible)
Example: text/plain; charset=UTF-8, image/png
.... language 0..1codeXDSDocumentEntry.languageCode
Binding: Language (required, not extensible)
Example: en-AU
.... data 0..1base64BinaryData inline, base64ed
.... url 0..1urirepository location (by implication & configuration)
Example: http://www.acme.com/logo-small.png
.... size 0..1integerXDSDocumentEntry.size
.... hash 0..1base64BinaryXDSDocumentEntry.hash
.... title 0..1stringLabel to display in place of the data
Example: "Official Corporate Logo"
... context 0..1event codes, service Start & Stop time, and facility type
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... event 0..*CodeableConceptXDSDocumentEntry.eventCodeList
Binding: DocumentEventType (preferred, extensible)
.... period 1..1PeriodXDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime
.... facilityType 0..1CodeableConceptXDSDocumentEntry.healthCareFacilityTypeCode
Binding: DocumentFacilityType (example, extensible)

XML Template

JSON Template

todo

Differential View

This structure is derived from DocumentReference.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 1..1XDSDocumentEntry
... masterIdentifier 1..1IdentifierXDSDocumentEntry.uniqueId
... identifier 0..*IdentifierXDSDocumentEntry.referenceIdList
... subject 1..1PatientXDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo
... type 1..1CodeableConceptXDSDocumentEntry.typeCode
... class 1..1CodeableConceptXDSDocumentEntry.classCode
... format 1..1uriXDSDocumentEntry.formatCode
... author 1..*Practitioner, DeviceXDSDocumentEntry.author
... custodian 0..0Organization
... policyManager 0..1uriXDSDocumentEntry.homeCommunityId
... authenticator 0..1Practitioner??
... created 1..1dateTimeXDSDocumentEntry.creationTime
... indexed 1..1instantXDS submission time or XDSDocumentEntry.creationTime if unknown
... status 1..1codeimplied by XDS workflow
... docStatus 0..0CodeableConcept
... relatesTo 0..*Relationships that this document has with other document references that already exist
.... code 1..1codeThe type of relationship that this document has with anther document
.... target 1..1DocumentReferenceThe target document of this relationship
... description 0..1stringXDSDocumentEntry.title
... confidentiality 1..1CodeableConceptXDSDocumentEntry.confidentialityCode
... content
.... contentType 1..1codeXDSDocumentEntry.mimeType
.... language 0..1codeXDSDocumentEntry.languageCode
.... url 0..1urirepository location (by implication & configuration)
.... size 0..1integerXDSDocumentEntry.size
.... hash 0..1base64BinaryXDSDocumentEntry.hash
... context 0..1event codes, service Start & Stop time, and facility type
.... event 0..*CodeableConceptXDSDocumentEntry.eventCodeList
.... period 1..1PeriodXDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime
.... facilityType 0..1CodeableConceptXDSDocumentEntry.healthCareFacilityTypeCode

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 1..1XDSDocumentEntry
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... masterIdentifier 1..1IdentifierXDSDocumentEntry.uniqueId
... identifier 0..*IdentifierXDSDocumentEntry.referenceIdList
... subject 1..1PatientXDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo
... type 1..1CodeableConceptXDSDocumentEntry.typeCode
Binding: DocumentType (preferred, extensible)
... class 1..1CodeableConceptXDSDocumentEntry.classCode
Binding: DocumentClass (example, extensible)
... format 1..1uriXDSDocumentEntry.formatCode
... author 1..*Practitioner, DeviceXDSDocumentEntry.author
... policyManager 0..1uriXDSDocumentEntry.homeCommunityId
... authenticator 0..1Practitioner??
... created 1..1dateTimeXDSDocumentEntry.creationTime
... indexed 1..1instantXDS submission time or XDSDocumentEntry.creationTime if unknown
... status M1..1codeimplied by XDS workflow
Binding: DocumentReferenceStatus (required, not extensible)
... relatesTo M0..*Relationships that this document has with other document references that already exist
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... code 1..1codeThe type of relationship that this document has with anther document
Binding: DocumentRelationshipType (required, not extensible)
.... target 1..1DocumentReferenceThe target document of this relationship
... description 0..1stringXDSDocumentEntry.title
... confidentiality M1..1CodeableConceptXDSDocumentEntry.confidentialityCode
Binding: DocumentConfidentiality (preferred, extensible)
... content 1..*AttachmentWhere to access the document
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... contentType 1..1codeXDSDocumentEntry.mimeType
Binding: MimeType (required, not extensible)
Example: text/plain; charset=UTF-8, image/png
.... language 0..1codeXDSDocumentEntry.languageCode
Binding: Language (required, not extensible)
Example: en-AU
.... data 0..1base64BinaryData inline, base64ed
.... url 0..1urirepository location (by implication & configuration)
Example: http://www.acme.com/logo-small.png
.... size 0..1integerXDSDocumentEntry.size
.... hash 0..1base64BinaryXDSDocumentEntry.hash
.... title 0..1stringLabel to display in place of the data
Example: "Official Corporate Logo"
... context 0..1event codes, service Start & Stop time, and facility type
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... event 0..*CodeableConceptXDSDocumentEntry.eventCodeList
Binding: DocumentEventType (preferred, extensible)
.... period 1..1PeriodXDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime
.... facilityType 0..1CodeableConceptXDSDocumentEntry.healthCareFacilityTypeCode
Binding: DocumentFacilityType (example, extensible)

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
DocumentReference.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
DocumentReference.typeDocumentTypepreferred (extensible)FHIR Document Codes
DocumentReference.classDocumentClassexample (extensible)XDS Connect-a-thon healthcareFacilityTypeCodes
DocumentReference.statusDocumentReferenceStatusrequiredDocumentReferenceStatus
DocumentReference.docStatusReferredDocumentStatuspreferred (extensible)CompositionStatus
DocumentReference.relatesTo.codeDocumentRelationshipTyperequiredDocumentRelationshipType
DocumentReference.confidentialityDocumentConfidentialitypreferred (extensible)v3 Code System Confidentiality
DocumentReference.content.contentTypeMimeTyperequiredhttp://www.rfc-editor.org/bcp/bcp13.txt
DocumentReference.content.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
DocumentReference.context.eventDocumentEventTypepreferred (extensible)v3 Code System ActCode
DocumentReference.context.facilityTypeDocumentFacilityTypeexample (extensible)XDS Connect-a-thon healthcareFacilityTypeCodes

Constraints

IdPathNameDetails
.