XealthIG
v1.44.0 - release

XealthIG - Local Development build (vv1.44.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Xealth Partner DocumentReference Media

Official URL: https://fhir.xealth.io/StructureDefinition/xealth-partner-document-reference-media Version: v1.44.0
Active as of 2026-04-14 Computable Name: XealthPartnerDocumentReferenceMedia

Defines Xealth Partner constraints on DocumentReference for representing Media.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta SΣ 1..1 Meta Metadata about the resource
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... tag Σ 0..* Coding Managed by Xealth.
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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... masterIdentifier Σ 0..1 Identifier Managed by Xealth.
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: Xealth DocumentReference Valid Status Value Set (required)
... docStatus SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: Xealth DocumentReference Valid Doc Status Value Set (required)
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Managed by Xealth.
... date SΣ 1..1 instant Time the DocumentReference is sent to Xealth. ex: 2017-02-01T00:00:00Z
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Managed by Xealth.
... securityLabel Σ 0..* CodeableConcept Managed by Xealth.
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Where to access the document
..... 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.
Required Pattern: application/pdf
..... data S 1..1 base64Binary base64Binary encoded PDF, which adheres to RFC8118
..... title SΣ 1..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣC 1..1 dateTime Time the attached content was created, formatted as an instant. ex: 2017-01-01T00:00:00Z
Constraints: dateTime-format-invariant
... context SΣ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... related S 1..* Reference(ServiceRequest) The Xealth order this DocumentReference is based on.
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.status Base required Xealth DocumentReference Valid Status Value Set 📦v1.44.0 This IG
DocumentReference.docStatus Base required Xealth DocumentReference Valid Doc Status Value Set 📦v1.44.0 This IG
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dateTime-format-invariant error DocumentReference.content.attachment.creation Should only accept a datetime that adheres to the constraint of instant. ex: 2017-01-01T00:00:00Z $this.toString().length() >= 20
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If 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-4 error DocumentReference If 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-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta S 1..1 Meta Metadata about the resource
.... profile S 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... tag 0..* Coding Managed by Xealth.
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... masterIdentifier 0..1 Identifier Managed by Xealth.
... docStatus S 1..1 code preliminary | final | amended | entered-in-error
Binding: Xealth DocumentReference Valid Doc Status Value Set (required)
... subject 0..1 Reference(Patient | Practitioner | Group | Device) Managed by Xealth.
... date S 1..1 instant Time the DocumentReference is sent to Xealth. ex: 2017-02-01T00:00:00Z
... author 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Managed by Xealth.
... securityLabel 0..* CodeableConcept Managed by Xealth.
... content S 1..1 BackboneElement Document referenced
.... attachment S 1..1 Attachment Where to access the document
..... contentType S 1..1 code Mime type of the content, with charset etc.
Required Pattern: application/pdf
..... data S 1..1 base64Binary base64Binary encoded PDF, which adheres to RFC8118
..... url S 0..0 Uri where the data can be found
..... title S 1..1 string Label to display in place of the data
..... creation SC 1..1 dateTime Time the attached content was created, formatted as an instant. ex: 2017-01-01T00:00:00Z
Constraints: dateTime-format-invariant
... context S 1..1 BackboneElement Clinical context of document
.... related S 1..* Reference(ServiceRequest) The Xealth order this DocumentReference is based on.
..... reference S 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.status Base required Xealth DocumentReference Valid Status Value Set 📦v1.44.0 This IG
DocumentReference.docStatus Base required Xealth DocumentReference Valid Doc Status Value Set 📦v1.44.0 This IG

Constraints

Id Grade Path(s) Description Expression
dateTime-format-invariant error DocumentReference.content.attachment.creation Should only accept a datetime that adheres to the constraint of instant. ex: 2017-01-01T00:00:00Z $this.toString().length() >= 20
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 1..1 Meta 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 Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Managed by Xealth.
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:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Managed by Xealth.
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: Xealth DocumentReference Valid Status Value Set (required)
... docStatus SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: Xealth DocumentReference Valid Doc Status Value Set (required)
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Managed by Xealth.
... date SΣ 1..1 instant Time the DocumentReference is sent to Xealth. ex: 2017-02-01T00:00:00Z
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Managed by Xealth.
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... 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 Managed by Xealth.
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.
Required Pattern: application/pdf
..... 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 base64Binary encoded PDF, which adheres to RFC8118
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 1..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣC 1..1 dateTime Time the attached content was created, formatted as an instant. ex: 2017-01-01T00:00:00Z
Constraints: dateTime-format-invariant
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context SΣ 1..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 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... 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 S 1..* Reference(ServiceRequest) The Xealth order this DocumentReference is based on.
..... 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 SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required Xealth DocumentReference Valid Status Value Set 📦v1.44.0 This IG
DocumentReference.docStatus Base required Xealth DocumentReference Valid Doc Status Value Set 📦v1.44.0 This IG
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.1
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​related.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dateTime-format-invariant error DocumentReference.content.attachment.creation Should only accept a datetime that adheres to the constraint of instant. ex: 2017-01-01T00:00:00Z $this.toString().length() >= 20
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If 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-4 error DocumentReference If 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-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DocumentReference

Summary

Mandatory: 11 elements
Must-Support: 15 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta SΣ 1..1 Meta Metadata about the resource
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... tag Σ 0..* Coding Managed by Xealth.
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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... masterIdentifier Σ 0..1 Identifier Managed by Xealth.
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: Xealth DocumentReference Valid Status Value Set (required)
... docStatus SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: Xealth DocumentReference Valid Doc Status Value Set (required)
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Managed by Xealth.
... date SΣ 1..1 instant Time the DocumentReference is sent to Xealth. ex: 2017-02-01T00:00:00Z
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Managed by Xealth.
... securityLabel Σ 0..* CodeableConcept Managed by Xealth.
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Where to access the document
..... 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.
Required Pattern: application/pdf
..... data S 1..1 base64Binary base64Binary encoded PDF, which adheres to RFC8118
..... title SΣ 1..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣC 1..1 dateTime Time the attached content was created, formatted as an instant. ex: 2017-01-01T00:00:00Z
Constraints: dateTime-format-invariant
... context SΣ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... related S 1..* Reference(ServiceRequest) The Xealth order this DocumentReference is based on.
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.status Base required Xealth DocumentReference Valid Status Value Set 📦v1.44.0 This IG
DocumentReference.docStatus Base required Xealth DocumentReference Valid Doc Status Value Set 📦v1.44.0 This IG
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dateTime-format-invariant error DocumentReference.content.attachment.creation Should only accept a datetime that adheres to the constraint of instant. ex: 2017-01-01T00:00:00Z $this.toString().length() >= 20
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If 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-4 error DocumentReference If 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-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta S 1..1 Meta Metadata about the resource
.... profile S 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... tag 0..* Coding Managed by Xealth.
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... masterIdentifier 0..1 Identifier Managed by Xealth.
... docStatus S 1..1 code preliminary | final | amended | entered-in-error
Binding: Xealth DocumentReference Valid Doc Status Value Set (required)
... subject 0..1 Reference(Patient | Practitioner | Group | Device) Managed by Xealth.
... date S 1..1 instant Time the DocumentReference is sent to Xealth. ex: 2017-02-01T00:00:00Z
... author 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Managed by Xealth.
... securityLabel 0..* CodeableConcept Managed by Xealth.
... content S 1..1 BackboneElement Document referenced
.... attachment S 1..1 Attachment Where to access the document
..... contentType S 1..1 code Mime type of the content, with charset etc.
Required Pattern: application/pdf
..... data S 1..1 base64Binary base64Binary encoded PDF, which adheres to RFC8118
..... url S 0..0 Uri where the data can be found
..... title S 1..1 string Label to display in place of the data
..... creation SC 1..1 dateTime Time the attached content was created, formatted as an instant. ex: 2017-01-01T00:00:00Z
Constraints: dateTime-format-invariant
... context S 1..1 BackboneElement Clinical context of document
.... related S 1..* Reference(ServiceRequest) The Xealth order this DocumentReference is based on.
..... reference S 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.status Base required Xealth DocumentReference Valid Status Value Set 📦v1.44.0 This IG
DocumentReference.docStatus Base required Xealth DocumentReference Valid Doc Status Value Set 📦v1.44.0 This IG

Constraints

Id Grade Path(s) Description Expression
dateTime-format-invariant error DocumentReference.content.attachment.creation Should only accept a datetime that adheres to the constraint of instant. ex: 2017-01-01T00:00:00Z $this.toString().length() >= 20

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 1..1 Meta 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 Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Managed by Xealth.
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:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Managed by Xealth.
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: Xealth DocumentReference Valid Status Value Set (required)
... docStatus SΣ 1..1 code preliminary | final | amended | entered-in-error
Binding: Xealth DocumentReference Valid Doc Status Value Set (required)
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Managed by Xealth.
... date SΣ 1..1 instant Time the DocumentReference is sent to Xealth. ex: 2017-02-01T00:00:00Z
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Managed by Xealth.
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... 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 Managed by Xealth.
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.
Required Pattern: application/pdf
..... 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 base64Binary encoded PDF, which adheres to RFC8118
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 1..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣC 1..1 dateTime Time the attached content was created, formatted as an instant. ex: 2017-01-01T00:00:00Z
Constraints: dateTime-format-invariant
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context SΣ 1..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 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... 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 S 1..* Reference(ServiceRequest) The Xealth order this DocumentReference is based on.
..... 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 SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required Xealth DocumentReference Valid Status Value Set 📦v1.44.0 This IG
DocumentReference.docStatus Base required Xealth DocumentReference Valid Doc Status Value Set 📦v1.44.0 This IG
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.1
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​related.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dateTime-format-invariant error DocumentReference.content.attachment.creation Should only accept a datetime that adheres to the constraint of instant. ex: 2017-01-01T00:00:00Z $this.toString().length() >= 20
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If 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-4 error DocumentReference If 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-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DocumentReference

Summary

Mandatory: 11 elements
Must-Support: 15 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron