Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Nictiz.IHE.MHD.Provide.Minimal.DocumentReference - Detailed Descriptions

Active as of 2019-07-29

Definitions for the IHE.MHD.Provide.Minimal.DocumentReference resource profile.

Guidance on how to interpret the contents of this table can be found here

0. DocumentReference
2. DocumentReference.masterIdentifier
Comments

See ITI TF-2x: Z.9.1.1 Identifier and CDA root plus extension.

Control1..?
Must Supporttrue
4. DocumentReference.identifier
Comments

When the DocumentReference.identifier carries the entryUUID then the DocumentReference.identifier use shall be ‘official’.

NoteThis is a business identifier, not a resource identifier (see discussion)
Must Supporttrue
6. DocumentReference.status
Comments

approved -> status=current deprecated -> status=superseded

Must Supportfalse
8. DocumentReference.docStatus
Comments

These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values

Control0..0
10. DocumentReference.type
Must Supporttrue
12. DocumentReference.class
Must Supporttrue
14. DocumentReference.subject
Comments

Not a contained resource. URL Points to an existing Patient Resource representing the XDS Affinity Domain Patient.

TypeReference(Patient)referenced, bundled
Must Supporttrue
16. DocumentReference.created
Control0..0
18. DocumentReference.indexed
Must Supporttrue
20. DocumentReference.author
Comments

Contained resource of type Practitioner with: * authorInstitution: Organization * authorPerson: Practitioner.identifier and Practitioner.name * authorRole: — Not supported in STU3 * authorSpecialty: Practitioner.qualification * authorTelecommunication: Practitioner.telecom

TypeReference(Practitioner, Organization)contained
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
22. DocumentReference.authenticator
Comments

Contained resource

TypeReferencecontained
Must Supportfalse
24. DocumentReference.custodian
Comments

These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values.

Control0..0
26. DocumentReference.relatesTo
Comments

See ITI TF-2c: 3.65.4.1.2.3

Must Supporttrue
28. DocumentReference.description
Must Supportfalse
30. DocumentReference.securityLabel
Comments

Note: This is NOT the DocumentReference.meta, as that holds the meta tags for the DocumentReference itself.

Must Supporttrue
32. DocumentReference.content
Control0..1
Must Supporttrue
34. DocumentReference.content.attachment
Must Supporttrue
36. DocumentReference.content.attachment.contentType
Control1..?
Must Supporttrue
38. DocumentReference.content.attachment.language
Must Supporttrue
40. DocumentReference.content.attachment.data
Comments

These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values.

Control0..0
42. DocumentReference.content.attachment.url
Control1..?
Must Supporttrue
44. DocumentReference.content.attachment.size
Comments

The size is calculated on the data prior to base64 encoding, if the data is base64 encoded.

Must Supportfalse
46. DocumentReference.content.attachment.hash
Comments

The IHE Document Sharing metadata element hash holds the SHA1 hash of the document. The hash is encoded in FHIR in base64Binary, whereas in XDS hexbinary is used. The hash is calculated on the data prior to base64 encoding, if the data is base64 encoded.

Must Supportfalse
48. DocumentReference.content.attachment.title
Must Supportfalse
50. DocumentReference.content.attachment.creation
Comments

These HL7 FHIR STU3 elements are not used in XDS, therefore would not be present. Document Consumers should be robust to these elements holding values.

Control0..0
52. DocumentReference.content.format
BindingThe codes SHOULD be taken from IHE ValueSet of Format Codes for use with Document Sharing
(preferred to http://ihe.net/fhir/ValueSet/IHE.formatcode.vs)
Must Supporttrue
54. DocumentReference.context
Must Supportfalse
56. DocumentReference.context.encounter
Comments

When referenceIdList contains an encounter, and a FHIR Encounter is available, it may be referenced.

Must Supportfalse
58. DocumentReference.context.event
Must Supportfalse
60. DocumentReference.context.period
Must Supporttrue
62. DocumentReference.context.facilityType
Must Supporttrue
64. DocumentReference.context.practiceSetting
Must Supporttrue
66. DocumentReference.context.sourcePatientInfo
Comments

Contained Patient resource with Patient.identifier.use element set to ‘usual’.

Indicates that the data within the XDS document entry be represented as a contained resource. See Section 4.5.4.4.7

TypeReferencecontained
Must Supporttrue
68. DocumentReference.context.related
Must Supportfalse
70. DocumentReference.context.related.identifier
Comments

See ITI TF-2x: Appendix E.3.1 on CXi mapping to FHIR Identifier

NoteThis is a business identifier, not a resource identifier (see discussion)
Must Supportfalse
72. DocumentReference.context.related.ref
Comments

May be filled with URL pointers to Resources found in referenceIdList

Must Supportfalse