MediRecords FHIR Implementation Guide
1.4.2 - release


Resource Profile: MR DocumentReference Out Write

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-documentreference-out-write
Version:1.4.2
Name:MRDocumentReferenceOutWrite
Title:MR DocumentReference Out Write
Status:Active as of 2026-07-23 04:29:22+0000
Definition:

Medirecords DocumentReference profile used for writing back a new correspondence out document.

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://fhir.medirecords.com/StructureDefinition/mr-documentreference-out-write

Formal Views of Profile Content

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

This structure is derived from MRDocumentReference

Summary

Mandatory: 9 elements(4 nested mandatory elements)
Must-Support: 11 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from MRDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MRDocumentReference Document written back to Correspondence Out
... meta
.... security 0..1 Coding Security Labels applied to this resource
Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-Confidentiality
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: U
... Slices for extension Content/Rules for all slices
.... extension:recipient S 0..1 MRDocumentRefRecipientExtn Intended recipient of the document
..... value[x]
...... type S 1..1 uri PractitionerRole | Organization
...... display S 1..1 string Name of the individual or organisation who is the intended recipient of the document
.... extension:documentTitle S 0..1 MRDocumentRefTitleExtn MR DocumentReference Title Extension
..... value[x] 0..1 string Document title
Max Length:100
.... extension:outboundDetails S 0..1 (Complex) Outbound delivery details
URL: https://fhir.medirecords.com/StructureDefinition/mr-outbound-details
..... extension 2..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:status S 1..1 Extension The outbound delivery status of the document
...... extension:messageId S 1..1 Extension The outbound message identifier used to correlate acknowledgment messages with updated outbound delivery status.
... status 1..1 code Indicates document is Active(current)
Fixed Value: current
... type 1..1 CodeableConcept Correspondence out document type
Binding: MediRecords Document Reference Letter Type (extensible)
... category 1..1 CodeableConcept Correspondence out document category
Binding: MediRecords Document Reference Letter Category (extensible)
... date 1..1 instant When this document reference was created
... author S 1..1 Reference(MR PractitionerRole) Who and/or what authored the document
.... reference 1..1 string Reference to PractitionerRole representing MediRecords userPractice
... custodian 1..1 Reference(MR Organisation) Organization which maintains the document
.... reference 1..1 string Reference to Organization representing MediRecords practice
... content S 1..1 BackboneElement Document referenced
.... attachment S 1..1 Attachment Where to access the document
..... contentType 1..1 code Mime type of the content, with charset etc.
..... data 1..1 base64Binary Data inline, base64ed
... context S 0..1 BackboneElement Clinical context of document
.... encounter 0..1 Reference(MR Encounter | MR Encounter Admission) Reference to the patient encounter where the document was produced

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MRDocumentReference Document written back to Correspondence Out
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 MRMeta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security SΣC 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Constraints: inv-mr-meta-security-01

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-Confidentiality
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: U
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recipient S 0..1 (Complex) Intended recipient of the document
URL: https://fhir.medirecords.com/StructureDefinition/mr-document-ref-recipient-extn
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://fhir.medirecords.com/StructureDefinition/mr-document-ref-recipient-extn"
..... value[x] 1..1 Reference(MR Practitioner | MR Organisation | MR Patient) Document recipient
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type SΣ 1..1 uri PractitionerRole | Organization
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 1..1 string Name of the individual or organisation who is the intended recipient of the document
.... extension:documentTitle S 0..1 (Complex) MR DocumentReference Title Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-document-ref-title-extn
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://fhir.medirecords.com/StructureDefinition/mr-document-ref-title-extn"
..... value[x] 0..1 string Document title
Max Length:100
.... extension:namedNote 0..* (Complex) Note Extension with Name label
URL: https://fhir.medirecords.com/StructureDefinition/mr-named-note-extn
.... extension:outboundDetails S 0..1 (Complex) Outbound delivery details
URL: https://fhir.medirecords.com/StructureDefinition/mr-outbound-details
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:status S 1..1 Extension The outbound delivery status of the document
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "status"
....... value[x] 0..1 Coding Value of extension
Binding: MediRecords Outbound Status ValueSet (required)
...... extension:messageId S 1..1 Extension The outbound message identifier used to correlate acknowledgment messages with updated outbound delivery status.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "messageId"
....... value[x] 0..1 string Value of extension
..... url 1..1 uri "https://fhir.medirecords.com/StructureDefinition/mr-outbound-details"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!SΣC 1..1 code Indicates document is Active(current)
Binding: DocumentReferenceStatus (required): The status of the document reference.
Constraints: inv-mr-docref-in-status-01
Fixed Value: current
... docStatus SΣ 1..1 code Indicates if the document is Checked/Final (final)
Binding: CompositionStatus (required): Status of the underlying document.
Fixed Value: final
... type SΣ 1..1 CodeableConcept Correspondence out document type
Binding: MediRecords Document Reference Letter Type (extensible)
... category SΣ 1..1 CodeableConcept Correspondence out document category
Binding: MediRecords Document Reference Letter Category (extensible)
... subject SΣ 1..1 Reference(MR Patient) The patient who is the subject of the document
... date SΣ 1..1 instant When this document reference was created
... author SΣ 1..1 Reference(MR PractitionerRole) Who and/or what authored the document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Reference to PractitionerRole representing MediRecords userPractice
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... authenticator 0..1 Reference(MR Practitioner) The user from the practice who checked the document on upload
... custodian S 1..1 Reference(MR Organisation) Organization which maintains the document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Reference to Organization representing MediRecords practice
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..1 BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data S 1..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 0..1 string The file name of the attachment
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context SΣ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter S 0..1 Reference(MR Encounter | MR Encounter Admission) Reference to the patient encounter where the document was produced
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time of service that is being documented
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MRDocumentReference Document written back to Correspondence Out
... meta Σ 0..1 MRMeta Metadata about the resource
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... security ΣC 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-Confidentiality
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: U
... Slices for extension Content/Rules for all slices
.... extension:recipient 0..1 (Complex) Intended recipient of the document
URL: https://fhir.medirecords.com/StructureDefinition/mr-document-ref-recipient-extn
..... value[x] 1..1 Reference(MR Practitioner | MR Organisation | MR Patient) Document recipient
...... type Σ 1..1 uri PractitionerRole | Organization
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... display Σ 1..1 string Name of the individual or organisation who is the intended recipient of the document
.... extension:documentTitle 0..1 string MR DocumentReference Title Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-document-ref-title-extn
.... extension:outboundDetails 0..1 (Complex) Outbound delivery details
URL: https://fhir.medirecords.com/StructureDefinition/mr-outbound-details
..... Slices for extension Content/Rules for all slices
...... extension:status 1..1 Extension The outbound delivery status of the document
...... extension:messageId 1..1 Extension The outbound message identifier used to correlate acknowledgment messages with updated outbound delivery status.
... status ?!ΣC 1..1 code Indicates document is Active(current)
Binding: DocumentReferenceStatus (required): The status of the document reference.
Fixed Value: current
... type Σ 1..1 CodeableConcept Correspondence out document type
Binding: MediRecords Document Reference Letter Type (extensible)
... category Σ 1..1 CodeableConcept Correspondence out document category
Binding: MediRecords Document Reference Letter Category (extensible)
... subject Σ 1..1 Reference(MR Patient) The patient who is the subject of the document
... date Σ 1..1 instant When this document reference was created
... author Σ 1..1 Reference(MR PractitionerRole) Who and/or what authored the document
... custodian 1..1 Reference(MR Organisation) Organization which maintains the document
... content Σ 1..1 BackboneElement Document referenced
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
..... data 1..1 base64Binary Data inline, base64ed
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... title Σ 0..1 string The file name of the attachment
... context Σ 0..1 BackboneElement Clinical context of document
.... encounter 0..1 Reference(MR Encounter | MR Encounter Admission) Reference to the patient encounter where the document was produced

doco Documentation for this format

This structure is derived from MRDocumentReference

Summary

Mandatory: 9 elements(4 nested mandatory elements)
Must-Support: 11 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from MRDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MRDocumentReference Document written back to Correspondence Out
... meta
.... security 0..1 Coding Security Labels applied to this resource
Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-Confidentiality
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: U
... Slices for extension Content/Rules for all slices
.... extension:recipient S 0..1 MRDocumentRefRecipientExtn Intended recipient of the document
..... value[x]
...... type S 1..1 uri PractitionerRole | Organization
...... display S 1..1 string Name of the individual or organisation who is the intended recipient of the document
.... extension:documentTitle S 0..1 MRDocumentRefTitleExtn MR DocumentReference Title Extension
..... value[x] 0..1 string Document title
Max Length:100
.... extension:outboundDetails S 0..1 (Complex) Outbound delivery details
URL: https://fhir.medirecords.com/StructureDefinition/mr-outbound-details
..... extension 2..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:status S 1..1 Extension The outbound delivery status of the document
...... extension:messageId S 1..1 Extension The outbound message identifier used to correlate acknowledgment messages with updated outbound delivery status.
... status 1..1 code Indicates document is Active(current)
Fixed Value: current
... type 1..1 CodeableConcept Correspondence out document type
Binding: MediRecords Document Reference Letter Type (extensible)
... category 1..1 CodeableConcept Correspondence out document category
Binding: MediRecords Document Reference Letter Category (extensible)
... date 1..1 instant When this document reference was created
... author S 1..1 Reference(MR PractitionerRole) Who and/or what authored the document
.... reference 1..1 string Reference to PractitionerRole representing MediRecords userPractice
... custodian 1..1 Reference(MR Organisation) Organization which maintains the document
.... reference 1..1 string Reference to Organization representing MediRecords practice
... content S 1..1 BackboneElement Document referenced
.... attachment S 1..1 Attachment Where to access the document
..... contentType 1..1 code Mime type of the content, with charset etc.
..... data 1..1 base64Binary Data inline, base64ed
... context S 0..1 BackboneElement Clinical context of document
.... encounter 0..1 Reference(MR Encounter | MR Encounter Admission) Reference to the patient encounter where the document was produced

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MRDocumentReference Document written back to Correspondence Out
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 MRMeta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security SΣC 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Constraints: inv-mr-meta-security-01

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-Confidentiality
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: U
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recipient S 0..1 (Complex) Intended recipient of the document
URL: https://fhir.medirecords.com/StructureDefinition/mr-document-ref-recipient-extn
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://fhir.medirecords.com/StructureDefinition/mr-document-ref-recipient-extn"
..... value[x] 1..1 Reference(MR Practitioner | MR Organisation | MR Patient) Document recipient
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type SΣ 1..1 uri PractitionerRole | Organization
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 1..1 string Name of the individual or organisation who is the intended recipient of the document
.... extension:documentTitle S 0..1 (Complex) MR DocumentReference Title Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-document-ref-title-extn
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://fhir.medirecords.com/StructureDefinition/mr-document-ref-title-extn"
..... value[x] 0..1 string Document title
Max Length:100
.... extension:namedNote 0..* (Complex) Note Extension with Name label
URL: https://fhir.medirecords.com/StructureDefinition/mr-named-note-extn
.... extension:outboundDetails S 0..1 (Complex) Outbound delivery details
URL: https://fhir.medirecords.com/StructureDefinition/mr-outbound-details
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:status S 1..1 Extension The outbound delivery status of the document
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "status"
....... value[x] 0..1 Coding Value of extension
Binding: MediRecords Outbound Status ValueSet (required)
...... extension:messageId S 1..1 Extension The outbound message identifier used to correlate acknowledgment messages with updated outbound delivery status.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "messageId"
....... value[x] 0..1 string Value of extension
..... url 1..1 uri "https://fhir.medirecords.com/StructureDefinition/mr-outbound-details"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!SΣC 1..1 code Indicates document is Active(current)
Binding: DocumentReferenceStatus (required): The status of the document reference.
Constraints: inv-mr-docref-in-status-01
Fixed Value: current
... docStatus SΣ 1..1 code Indicates if the document is Checked/Final (final)
Binding: CompositionStatus (required): Status of the underlying document.
Fixed Value: final
... type SΣ 1..1 CodeableConcept Correspondence out document type
Binding: MediRecords Document Reference Letter Type (extensible)
... category SΣ 1..1 CodeableConcept Correspondence out document category
Binding: MediRecords Document Reference Letter Category (extensible)
... subject SΣ 1..1 Reference(MR Patient) The patient who is the subject of the document
... date SΣ 1..1 instant When this document reference was created
... author SΣ 1..1 Reference(MR PractitionerRole) Who and/or what authored the document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Reference to PractitionerRole representing MediRecords userPractice
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... authenticator 0..1 Reference(MR Practitioner) The user from the practice who checked the document on upload
... custodian S 1..1 Reference(MR Organisation) Organization which maintains the document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Reference to Organization representing MediRecords practice
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..1 BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data S 1..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 0..1 string The file name of the attachment
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context SΣ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter S 0..1 Reference(MR Encounter | MR Encounter Admission) Reference to the patient encounter where the document was produced
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time of service that is being documented
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.meta.securityextensiblePattern Value: U
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
DocumentReference.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
DocumentReference.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.extension:recipient.value[x].typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
DocumentReference.extension:outboundDetails.extension:status.value[x]requiredMROutboundStatusValueSet
https://fhir.medirecords.com/ValueSet/mr-outbound-status-vs
From this IG
DocumentReference.statusrequiredFixed Value: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
From the FHIR Standard
DocumentReference.docStatusrequiredFixed Value: final
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
From the FHIR Standard
DocumentReference.typeextensibleMRDocumentLetterType
https://fhir.medirecords.com/ValueSet/mr-document-letter-type
From this IG
DocumentReference.categoryextensibleMRDocumentLetterCategory
https://fhir.medirecords.com/ValueSet/mr-document-letter-category
From this IG
DocumentReference.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
DocumentReference.custodian.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
From the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
From the FHIR Standard
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
From the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-mr-docref-in-status-01errorDocumentReference.statusMediRecords supports only current - 'This is the current reference for this document' or entered-in-error - 'This reference was created in error'
: $this.exists() implies ($this = 'current' or $this = 'entered-in-error')
inv-mr-meta-security-01errorDocumentReference.meta.securityMedirecords supports only U, R security code
: code.exists() implies (code = 'U' or code = 'R')