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

StructureDefinition: DocumentReference

The official URL for this profile is: 

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

XDSDocumentEntry

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

Formal Views of Profile Content

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

This structure is derived from DocumentReference.

Summary

Required/Prohibited Elements

  • 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

This structure is derived from DocumentReference.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 1..1DocumentReferenceXDSDocumentEntry
... policyManager 0..1uriXDSDocumentEntry.homeCommunityId
... 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
... 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
.... practiceSetting XDSDocumentEntry.practiceSettingCode
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 1..1DocumentReferenceXDSDocumentEntry
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... 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: DocumentC80Type (preferred)
... class 1..1CodeableConceptXDSDocumentEntry.classCode
Binding: DocumentC80Class (preferred)
... format 1..1uriXDSDocumentEntry.formatCode
Binding: DocumentIHEFormat (preferred)
... author 1..*Practitioner, DeviceXDSDocumentEntry.author
... authenticator 0..1Practitioner??
... created 1..1dateTimeXDSDocumentEntry.creationTime
... indexed 1..1instantXDS submission time or XDSDocumentEntry.creationTime if unknown
... status ?!1..1codeimplied by XDS workflow
Binding: DocumentReferenceStatus (required)
... relatesTo ?!0..*Relationships that this document has with other document references that already exist
.... 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)
.... target 1..1DocumentReferenceThe target document of this relationship
... description 0..1stringXDSDocumentEntry.title
... confidentiality 1..1CodeableConceptXDSDocumentEntry.confidentialityCode
Binding: HCS (extensible)
... content 1..*AttachmentWhere to access the document
.... extension 0..*ExtensionAdditional Content defined by implementations
.... contentType 1..1codeXDSDocumentEntry.mimeType
Binding: MimeType (required)
Example: text/plain; charset=UTF-8, image/png
.... language 0..1codeXDSDocumentEntry.languageCode
Binding: Language (required)
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"
.... creation 0..1dateTimeDate attachment was first created
... context 0..1event codes, service Start & Stop time, and facility type
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... event 0..*CodeableConceptXDSDocumentEntry.eventCodeList
.... period 1..1PeriodXDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime
.... facilityType 0..1CodeableConceptXDSDocumentEntry.healthCareFacilityTypeCode
Binding: DocumentC80FacilityType (preferred)
.... practiceSetting 0..1CodeableConceptXDSDocumentEntry.practiceSettingCode
Binding: DocumentC80PracticeSetting (preferred)
.... sourcePatientInfo 0..1PatientSource patient info
.... related 0..*Related things
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... identifier 0..1IdentifierRelated Identifier
..... ref 0..1ResourceRelated Resource

todo

This structure is derived from DocumentReference.

Summary

Required/Prohibited Elements

  • 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

Differential View

This structure is derived from DocumentReference.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 1..1DocumentReferenceXDSDocumentEntry
... policyManager 0..1uriXDSDocumentEntry.homeCommunityId
... 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
... 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
.... practiceSetting XDSDocumentEntry.practiceSettingCode

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 1..1DocumentReferenceXDSDocumentEntry
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... 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: DocumentC80Type (preferred)
... class 1..1CodeableConceptXDSDocumentEntry.classCode
Binding: DocumentC80Class (preferred)
... format 1..1uriXDSDocumentEntry.formatCode
Binding: DocumentIHEFormat (preferred)
... author 1..*Practitioner, DeviceXDSDocumentEntry.author
... authenticator 0..1Practitioner??
... created 1..1dateTimeXDSDocumentEntry.creationTime
... indexed 1..1instantXDS submission time or XDSDocumentEntry.creationTime if unknown
... status ?!1..1codeimplied by XDS workflow
Binding: DocumentReferenceStatus (required)
... relatesTo ?!0..*Relationships that this document has with other document references that already exist
.... 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)
.... target 1..1DocumentReferenceThe target document of this relationship
... description 0..1stringXDSDocumentEntry.title
... confidentiality 1..1CodeableConceptXDSDocumentEntry.confidentialityCode
Binding: HCS (extensible)
... content 1..*AttachmentWhere to access the document
.... extension 0..*ExtensionAdditional Content defined by implementations
.... contentType 1..1codeXDSDocumentEntry.mimeType
Binding: MimeType (required)
Example: text/plain; charset=UTF-8, image/png
.... language 0..1codeXDSDocumentEntry.languageCode
Binding: Language (required)
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"
.... creation 0..1dateTimeDate attachment was first created
... context 0..1event codes, service Start & Stop time, and facility type
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... event 0..*CodeableConceptXDSDocumentEntry.eventCodeList
.... period 1..1PeriodXDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime
.... facilityType 0..1CodeableConceptXDSDocumentEntry.healthCareFacilityTypeCode
Binding: DocumentC80FacilityType (preferred)
.... practiceSetting 0..1CodeableConceptXDSDocumentEntry.practiceSettingCode
Binding: DocumentC80PracticeSetting (preferred)
.... sourcePatientInfo 0..1PatientSource patient info
.... related 0..*Related things
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... identifier 0..1IdentifierRelated Identifier
..... ref 0..1ResourceRelated Resource

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

Terminology Bindings

PathNameConformanceValueSet
DocumentReference.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
DocumentReference.typeDocumentC80TypepreferredDocument Type Value Set
DocumentReference.classDocumentC80ClasspreferredDocument Class Value Set
DocumentReference.formatDocumentIHEFormatpreferredIHE Document Format Code Set
DocumentReference.statusDocumentReferenceStatusrequiredDocumentReferenceStatus
DocumentReference.docStatusReferredDocumentStatusrequiredCompositionStatus
DocumentReference.relatesTo.codeDocumentRelationshipTyperequiredDocumentRelationshipType
DocumentReference.confidentialityHCSextensibleAll Security Labels
DocumentReference.content.contentTypeMimeTyperequiredhttp://www.rfc-editor.org/bcp/bcp13.txt
DocumentReference.content.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
DocumentReference.context.facilityTypeDocumentC80FacilityTypepreferredFacililty Type Code Value Set
DocumentReference.context.practiceSettingDocumentC80PracticeSettingpreferredPractice Setting Code Value Set

Constraints

IdPathNameDetails
.