STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.37.11.4 StructureDefinition: XDSDocumentReference

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/xdsdocumentreference

XDSDocumentEntry

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

2.37.11.4.1 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

Mandatory: 8 elements (+1 nested mandatory element)
Prohibited: 3 elements

This structure is derived from DocumentReference.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*XDSDocumentEntry
... masterIdentifier 1..1IdentifierXDSDocumentEntry.uniqueId
... identifier 0..*IdentifierXDSDocumentEntry.referenceIdList
... subject 1..1Reference(Patient)XDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo
... type 1..1CodeableConceptXDSDocumentEntry.typeCode
... class 1..1CodeableConceptXDSDocumentEntry.classCode
... author 1..*Reference(Practitioner | Device)XDSDocumentEntry.author
... custodian 0..0
... authenticator 0..1Reference(Practitioner)??
... created 1..1dateTimeXDSDocumentEntry.creationTime
... indexed 1..1instantXDS submission time or XDSDocumentEntry.creationTime if unknown
... status 1..1codeimplied by XDS workflow
... docStatus 0..0
... relatesTo 0..*BackboneElementRelationships 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..1Reference(DocumentReference)The target document of this relationship
... description 0..1stringXDSDocumentEntry.title
... securityLabel 1..1CodeableConceptXDSDocumentEntry.confidentialityCode
... content 1..*BackboneElement
.... attachment 1..1Attachment
..... contentType 1..1codeXDSDocumentEntry.mimeType
..... language 0..1codeXDSDocumentEntry.languageCode
..... url 0..1urirepository location (by implication & configuration)
..... size 0..1unsignedIntXDSDocumentEntry.size
..... hash 0..1base64BinaryXDSDocumentEntry.hash
... context 0..1BackboneElementevent codes, service Start & Stop time, and facility type
.... encounter 0..0
.... event 0..*CodeableConceptXDSDocumentEntry.eventCodeList
.... period 1..1PeriodXDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime
.... facilityType 0..1CodeableConceptXDSDocumentEntry.healthCareFacilityTypeCode
.... practiceSetting 0..1CodeableConceptXDSDocumentEntry.practiceSettingCode

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference I0..*XDSDocumentEntry
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... 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: Common Languages (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..1Reference(Patient)XDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo
... type ∑1..1CodeableConceptXDSDocumentEntry.typeCode
Binding: Document Type Value Set (preferred)
... class ∑1..1CodeableConceptXDSDocumentEntry.classCode
Binding: Document Class Value Set (example)
... author ∑1..*Reference(Practitioner | Device)XDSDocumentEntry.author
... authenticator ∑0..1Reference(Practitioner)??
... 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..*BackboneElementRelationships that this document has with other document references that already exist
.... id 0..1stringxml: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)
.... target ∑1..1Reference(DocumentReference)The target document of this relationship
... description ∑0..1stringXDSDocumentEntry.title
... securityLabel ∑1..1CodeableConceptXDSDocumentEntry.confidentialityCode
Binding: All Security Labels (extensible)
... content ∑1..*BackboneElementDocument referenced
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... attachment ∑1..1AttachmentWhere to access the document
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... contentType ∑1..1codeXDSDocumentEntry.mimeType
Binding: IETF BCP-13 (required)
Example: text/plain; charset=UTF-8, image/png
..... language ∑0..1codeXDSDocumentEntry.languageCode
Binding: Common Languages (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..1unsignedIntXDSDocumentEntry.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
.... format ∑0..*CodingFormat/content rules for the document
Binding: DocumentReference Format Code Set (preferred)
... context ∑0..1BackboneElementevent codes, service Start & Stop time, and facility type
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... event ∑0..*CodeableConceptXDSDocumentEntry.eventCodeList
Binding: v3 Code System ActCode (example)
.... period ∑1..1PeriodXDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime
.... facilityType ∑0..1CodeableConceptXDSDocumentEntry.healthCareFacilityTypeCode
Binding: Facility Type Code Value Set (example)
.... practiceSetting ∑0..1CodeableConceptXDSDocumentEntry.practiceSettingCode
Binding: Practice Setting Code Value Set (example)
.... sourcePatientInfo ∑0..1Reference(Patient)Patient demographics from source
.... related ∑0..*BackboneElementRelated identifiers or resources
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... identifier ∑0..1IdentifierIdentifier of related objects or events
..... ref ∑0..1Reference(Resource)Related Resource

doco Documentation for this format

todo

This structure is derived from DocumentReference.

Summary

Mandatory: 8 elements (+1 nested mandatory element)
Prohibited: 3 elements

Differential View

This structure is derived from DocumentReference.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*XDSDocumentEntry
... masterIdentifier 1..1IdentifierXDSDocumentEntry.uniqueId
... identifier 0..*IdentifierXDSDocumentEntry.referenceIdList
... subject 1..1Reference(Patient)XDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo
... type 1..1CodeableConceptXDSDocumentEntry.typeCode
... class 1..1CodeableConceptXDSDocumentEntry.classCode
... author 1..*Reference(Practitioner | Device)XDSDocumentEntry.author
... custodian 0..0
... authenticator 0..1Reference(Practitioner)??
... created 1..1dateTimeXDSDocumentEntry.creationTime
... indexed 1..1instantXDS submission time or XDSDocumentEntry.creationTime if unknown
... status 1..1codeimplied by XDS workflow
... docStatus 0..0
... relatesTo 0..*BackboneElementRelationships 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..1Reference(DocumentReference)The target document of this relationship
... description 0..1stringXDSDocumentEntry.title
... securityLabel 1..1CodeableConceptXDSDocumentEntry.confidentialityCode
... content 1..*BackboneElement
.... attachment 1..1Attachment
..... contentType 1..1codeXDSDocumentEntry.mimeType
..... language 0..1codeXDSDocumentEntry.languageCode
..... url 0..1urirepository location (by implication & configuration)
..... size 0..1unsignedIntXDSDocumentEntry.size
..... hash 0..1base64BinaryXDSDocumentEntry.hash
... context 0..1BackboneElementevent codes, service Start & Stop time, and facility type
.... encounter 0..0
.... event 0..*CodeableConceptXDSDocumentEntry.eventCodeList
.... period 1..1PeriodXDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime
.... facilityType 0..1CodeableConceptXDSDocumentEntry.healthCareFacilityTypeCode
.... practiceSetting 0..1CodeableConceptXDSDocumentEntry.practiceSettingCode

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference I0..*XDSDocumentEntry
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... 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: Common Languages (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..1Reference(Patient)XDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo
... type ∑1..1CodeableConceptXDSDocumentEntry.typeCode
Binding: Document Type Value Set (preferred)
... class ∑1..1CodeableConceptXDSDocumentEntry.classCode
Binding: Document Class Value Set (example)
... author ∑1..*Reference(Practitioner | Device)XDSDocumentEntry.author
... authenticator ∑0..1Reference(Practitioner)??
... 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..*BackboneElementRelationships that this document has with other document references that already exist
.... id 0..1stringxml: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)
.... target ∑1..1Reference(DocumentReference)The target document of this relationship
... description ∑0..1stringXDSDocumentEntry.title
... securityLabel ∑1..1CodeableConceptXDSDocumentEntry.confidentialityCode
Binding: All Security Labels (extensible)
... content ∑1..*BackboneElementDocument referenced
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... attachment ∑1..1AttachmentWhere to access the document
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... contentType ∑1..1codeXDSDocumentEntry.mimeType
Binding: IETF BCP-13 (required)
Example: text/plain; charset=UTF-8, image/png
..... language ∑0..1codeXDSDocumentEntry.languageCode
Binding: Common Languages (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..1unsignedIntXDSDocumentEntry.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
.... format ∑0..*CodingFormat/content rules for the document
Binding: DocumentReference Format Code Set (preferred)
... context ∑0..1BackboneElementevent codes, service Start & Stop time, and facility type
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... event ∑0..*CodeableConceptXDSDocumentEntry.eventCodeList
Binding: v3 Code System ActCode (example)
.... period ∑1..1PeriodXDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime
.... facilityType ∑0..1CodeableConceptXDSDocumentEntry.healthCareFacilityTypeCode
Binding: Facility Type Code Value Set (example)
.... practiceSetting ∑0..1CodeableConceptXDSDocumentEntry.practiceSettingCode
Binding: Practice Setting Code Value Set (example)
.... sourcePatientInfo ∑0..1Reference(Patient)Patient demographics from source
.... related ∑0..*BackboneElementRelated identifiers or resources
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... identifier ∑0..1IdentifierIdentifier of related objects or events
..... ref ∑0..1Reference(Resource)Related Resource

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

2.37.11.4.2 Terminology Bindings

PathNameConformanceValueSet
DocumentReference.languageCommon LanguagesextensibleCommon Languages
DocumentReference.typeDocument Type Value SetpreferredDocument Type Value Set
DocumentReference.classDocument Class Value SetexampleDocument Class Value Set
DocumentReference.statusDocumentReferenceStatusrequiredDocumentReferenceStatus
DocumentReference.relatesTo.codeDocumentRelationshipTyperequiredDocumentRelationshipType
DocumentReference.securityLabelAll Security LabelsextensibleAll Security Labels
DocumentReference.content.attachment.contentType?extrequiredhttp://www.rfc-editor.org/bcp/bcp13.txt
DocumentReference.content.attachment.languageCommon LanguagesextensibleCommon Languages
DocumentReference.content.formatDocumentReference Format Code SetpreferredDocumentReference Format Code Set
DocumentReference.context.eventv3 Code System ActCodeexamplev3 Code System ActCode
DocumentReference.context.facilityTypeFacility Type Code Value SetexampleFacility Type Code Value Set
DocumentReference.context.practiceSettingPractice Setting Code Value SetexamplePractice Setting Code Value Set

2.37.11.4.3 Constraints

IdPathDetailsRequirements
dom-2DocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1DocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4DocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3DocumentReferenceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
.