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
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.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from DocumentReference.
This structure is derived from DocumentReference.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | XDSDocumentEntry | ||
![]() ![]() ![]() | 1..1 | Identifier | XDSDocumentEntry.uniqueId | |
![]() ![]() ![]() | 0..* | Identifier | XDSDocumentEntry.referenceIdList | |
![]() ![]() ![]() | 1..1 | Reference(Patient) | XDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo | |
![]() ![]() ![]() | 1..1 | CodeableConcept | XDSDocumentEntry.typeCode | |
![]() ![]() ![]() | 1..1 | CodeableConcept | XDSDocumentEntry.classCode | |
![]() ![]() ![]() | 1..* | Reference(Practitioner | Device) | XDSDocumentEntry.author | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..1 | Reference(Practitioner) | ?? | |
![]() ![]() ![]() | 1..1 | dateTime | XDSDocumentEntry.creationTime | |
![]() ![]() ![]() | 1..1 | instant | XDS submission time or XDSDocumentEntry.creationTime if unknown | |
![]() ![]() ![]() | 1..1 | code | implied by XDS workflow | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..* | BackboneElement | Relationships that this document has with other document references that already exist | |
![]() ![]() ![]() ![]() | 1..1 | code | The type of relationship that this document has with anther document | |
![]() ![]() ![]() ![]() | 1..1 | Reference(DocumentReference) | The target document of this relationship | |
![]() ![]() ![]() | 0..1 | string | XDSDocumentEntry.title | |
![]() ![]() ![]() | 1..1 | CodeableConcept | XDSDocumentEntry.confidentialityCode | |
![]() ![]() ![]() | 1..* | BackboneElement | ||
![]() ![]() ![]() ![]() | 1..1 | Attachment | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | XDSDocumentEntry.mimeType | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | XDSDocumentEntry.languageCode | |
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | repository location (by implication & configuration) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | unsignedInt | XDSDocumentEntry.size | |
![]() ![]() ![]() ![]() ![]() | 0..1 | base64Binary | XDSDocumentEntry.hash | |
![]() ![]() ![]() | 0..1 | BackboneElement | event codes, service Start & Stop time, and facility type | |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | XDSDocumentEntry.eventCodeList | |
![]() ![]() ![]() ![]() | 1..1 | Period | XDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | XDSDocumentEntry.healthCareFacilityTypeCode | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | XDSDocumentEntry.practiceSettingCode | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | 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 | |
![]() ![]() ![]() | ∑ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | ∑ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ∑ | 1..1 | Identifier | XDSDocumentEntry.uniqueId |
![]() ![]() ![]() | ∑ | 0..* | Identifier | XDSDocumentEntry.referenceIdList |
![]() ![]() ![]() | ∑ | 1..1 | Reference(Patient) | XDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo |
![]() ![]() ![]() | ∑ | 1..1 | CodeableConcept | XDSDocumentEntry.typeCode Binding: Document Type Value Set (preferred) |
![]() ![]() ![]() | ∑ | 1..1 | CodeableConcept | XDSDocumentEntry.classCode Binding: Document Class Value Set (example) |
![]() ![]() ![]() | ∑ | 1..* | Reference(Practitioner | Device) | XDSDocumentEntry.author |
![]() ![]() ![]() | ∑ | 0..1 | Reference(Practitioner) | ?? |
![]() ![]() ![]() | ∑ | 1..1 | dateTime | XDSDocumentEntry.creationTime |
![]() ![]() ![]() | ∑ | 1..1 | instant | XDS submission time or XDSDocumentEntry.creationTime if unknown |
![]() ![]() ![]() | ?!∑ | 1..1 | code | implied by XDS workflow Binding: DocumentReferenceStatus (required) |
![]() ![]() ![]() | ?!∑ | 0..* | BackboneElement | Relationships that this document has with other document references that already exist |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | ∑ | 1..1 | code | The type of relationship that this document has with anther document Binding: DocumentRelationshipType (required) |
![]() ![]() ![]() ![]() | ∑ | 1..1 | Reference(DocumentReference) | The target document of this relationship |
![]() ![]() ![]() | ∑ | 0..1 | string | XDSDocumentEntry.title |
![]() ![]() ![]() | ∑ | 1..1 | CodeableConcept | XDSDocumentEntry.confidentialityCode Binding: All Security Labels (extensible) |
![]() ![]() ![]() | ∑ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | ∑ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ∑ | 1..1 | code | XDSDocumentEntry.mimeType Binding: IETF BCP-13 ![]() Example: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | code | XDSDocumentEntry.languageCode Binding: Common Languages (extensible) Example: en-AU |
![]() ![]() ![]() ![]() ![]() | 0..1 | base64Binary | Data inline, base64ed | |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | uri | repository location (by implication & configuration) Example: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | unsignedInt | XDSDocumentEntry.size |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | base64Binary | XDSDocumentEntry.hash |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | string | Label to display in place of the data Example: Official Corporate Logo |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | dateTime | Date attachment was first created |
![]() ![]() ![]() ![]() | ∑ | 0..* | Coding | Format/content rules for the document Binding: DocumentReference Format Code Set (preferred) |
![]() ![]() ![]() | ∑ | 0..1 | BackboneElement | event codes, service Start & Stop time, and facility type |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | ∑ | 0..* | CodeableConcept | XDSDocumentEntry.eventCodeList Binding: v3 Code System ActCode (example) |
![]() ![]() ![]() ![]() | ∑ | 1..1 | Period | XDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime |
![]() ![]() ![]() ![]() | ∑ | 0..1 | CodeableConcept | XDSDocumentEntry.healthCareFacilityTypeCode Binding: Facility Type Code Value Set (example) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | CodeableConcept | XDSDocumentEntry.practiceSettingCode Binding: Practice Setting Code Value Set (example) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Reference(Patient) | Patient demographics from source |
![]() ![]() ![]() ![]() | ∑ | 0..* | BackboneElement | Related identifiers or resources |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | Identifier | Identifier of related objects or events |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | Reference(Resource) | Related Resource |
![]() |
todo
This structure is derived from DocumentReference.
Differential View
This structure is derived from DocumentReference.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | XDSDocumentEntry | ||
![]() ![]() ![]() | 1..1 | Identifier | XDSDocumentEntry.uniqueId | |
![]() ![]() ![]() | 0..* | Identifier | XDSDocumentEntry.referenceIdList | |
![]() ![]() ![]() | 1..1 | Reference(Patient) | XDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo | |
![]() ![]() ![]() | 1..1 | CodeableConcept | XDSDocumentEntry.typeCode | |
![]() ![]() ![]() | 1..1 | CodeableConcept | XDSDocumentEntry.classCode | |
![]() ![]() ![]() | 1..* | Reference(Practitioner | Device) | XDSDocumentEntry.author | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..1 | Reference(Practitioner) | ?? | |
![]() ![]() ![]() | 1..1 | dateTime | XDSDocumentEntry.creationTime | |
![]() ![]() ![]() | 1..1 | instant | XDS submission time or XDSDocumentEntry.creationTime if unknown | |
![]() ![]() ![]() | 1..1 | code | implied by XDS workflow | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..* | BackboneElement | Relationships that this document has with other document references that already exist | |
![]() ![]() ![]() ![]() | 1..1 | code | The type of relationship that this document has with anther document | |
![]() ![]() ![]() ![]() | 1..1 | Reference(DocumentReference) | The target document of this relationship | |
![]() ![]() ![]() | 0..1 | string | XDSDocumentEntry.title | |
![]() ![]() ![]() | 1..1 | CodeableConcept | XDSDocumentEntry.confidentialityCode | |
![]() ![]() ![]() | 1..* | BackboneElement | ||
![]() ![]() ![]() ![]() | 1..1 | Attachment | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | XDSDocumentEntry.mimeType | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | XDSDocumentEntry.languageCode | |
![]() ![]() ![]() ![]() ![]() | 0..1 | uri | repository location (by implication & configuration) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | unsignedInt | XDSDocumentEntry.size | |
![]() ![]() ![]() ![]() ![]() | 0..1 | base64Binary | XDSDocumentEntry.hash | |
![]() ![]() ![]() | 0..1 | BackboneElement | event codes, service Start & Stop time, and facility type | |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | XDSDocumentEntry.eventCodeList | |
![]() ![]() ![]() ![]() | 1..1 | Period | XDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | XDSDocumentEntry.healthCareFacilityTypeCode | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | XDSDocumentEntry.practiceSettingCode | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | 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 | |
![]() ![]() ![]() | ∑ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | ∑ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ∑ | 1..1 | Identifier | XDSDocumentEntry.uniqueId |
![]() ![]() ![]() | ∑ | 0..* | Identifier | XDSDocumentEntry.referenceIdList |
![]() ![]() ![]() | ∑ | 1..1 | Reference(Patient) | XDSDocumentEntry.patientId + sourcePatientId/sourcePatientInfo |
![]() ![]() ![]() | ∑ | 1..1 | CodeableConcept | XDSDocumentEntry.typeCode Binding: Document Type Value Set (preferred) |
![]() ![]() ![]() | ∑ | 1..1 | CodeableConcept | XDSDocumentEntry.classCode Binding: Document Class Value Set (example) |
![]() ![]() ![]() | ∑ | 1..* | Reference(Practitioner | Device) | XDSDocumentEntry.author |
![]() ![]() ![]() | ∑ | 0..1 | Reference(Practitioner) | ?? |
![]() ![]() ![]() | ∑ | 1..1 | dateTime | XDSDocumentEntry.creationTime |
![]() ![]() ![]() | ∑ | 1..1 | instant | XDS submission time or XDSDocumentEntry.creationTime if unknown |
![]() ![]() ![]() | ?!∑ | 1..1 | code | implied by XDS workflow Binding: DocumentReferenceStatus (required) |
![]() ![]() ![]() | ?!∑ | 0..* | BackboneElement | Relationships that this document has with other document references that already exist |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | ∑ | 1..1 | code | The type of relationship that this document has with anther document Binding: DocumentRelationshipType (required) |
![]() ![]() ![]() ![]() | ∑ | 1..1 | Reference(DocumentReference) | The target document of this relationship |
![]() ![]() ![]() | ∑ | 0..1 | string | XDSDocumentEntry.title |
![]() ![]() ![]() | ∑ | 1..1 | CodeableConcept | XDSDocumentEntry.confidentialityCode Binding: All Security Labels (extensible) |
![]() ![]() ![]() | ∑ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | ∑ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ∑ | 1..1 | code | XDSDocumentEntry.mimeType Binding: IETF BCP-13 ![]() Example: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | code | XDSDocumentEntry.languageCode Binding: Common Languages (extensible) Example: en-AU |
![]() ![]() ![]() ![]() ![]() | 0..1 | base64Binary | Data inline, base64ed | |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | uri | repository location (by implication & configuration) Example: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | unsignedInt | XDSDocumentEntry.size |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | base64Binary | XDSDocumentEntry.hash |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | string | Label to display in place of the data Example: Official Corporate Logo |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | dateTime | Date attachment was first created |
![]() ![]() ![]() ![]() | ∑ | 0..* | Coding | Format/content rules for the document Binding: DocumentReference Format Code Set (preferred) |
![]() ![]() ![]() | ∑ | 0..1 | BackboneElement | event codes, service Start & Stop time, and facility type |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | ∑ | 0..* | CodeableConcept | XDSDocumentEntry.eventCodeList Binding: v3 Code System ActCode (example) |
![]() ![]() ![]() ![]() | ∑ | 1..1 | Period | XDSDocumentEntry.serviceStartTime & XDSDocumentEntry.serviceStopTime |
![]() ![]() ![]() ![]() | ∑ | 0..1 | CodeableConcept | XDSDocumentEntry.healthCareFacilityTypeCode Binding: Facility Type Code Value Set (example) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | CodeableConcept | XDSDocumentEntry.practiceSettingCode Binding: Practice Setting Code Value Set (example) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Reference(Patient) | Patient demographics from source |
![]() ![]() ![]() ![]() | ∑ | 0..* | BackboneElement | Related identifiers or resources |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | Identifier | Identifier of related objects or events |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | Reference(Resource) | Related Resource |
![]() |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
DocumentReference.language | Common Languages | extensible | Common Languages |
DocumentReference.type | Document Type Value Set | preferred | Document Type Value Set |
DocumentReference.class | Document Class Value Set | example | Document Class Value Set |
DocumentReference.status | DocumentReferenceStatus | required | DocumentReferenceStatus |
DocumentReference.relatesTo.code | DocumentRelationshipType | required | DocumentRelationshipType |
DocumentReference.securityLabel | All Security Labels | extensible | All Security Labels |
DocumentReference.content.attachment.contentType | ?ext | required | http://www.rfc-editor.org/bcp/bcp13.txt ![]() |
DocumentReference.content.attachment.language | Common Languages | extensible | Common Languages |
DocumentReference.content.format | DocumentReference Format Code Set | preferred | DocumentReference Format Code Set |
DocumentReference.context.event | v3 Code System ActCode | example | v3 Code System ActCode |
DocumentReference.context.facilityType | Facility Type Code Value Set | example | Facility Type Code Value Set |
DocumentReference.context.practiceSetting | Practice Setting Code Value Set | example | Practice Setting Code Value Set |
Id | Path | Details | Requirements |
dom-2 | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
dom-1 | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
dom-4 | DocumentReference | If 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-3 | DocumentReference | If 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))])) |