eLab posistemės integracijos dokumentacija
0.3.31 - versija Lithuania flag

eLab posistemės integracijos dokumentacija - Local Development build (v0.3.31) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Profilis: LtDocumentReference

Official URL: http://esveikata.lt/fhir/StructureDefinition/lt-documentReference Version: 0.3.31
Active as of 2025-01-07 Computable Name: LtDocumentReference

Dokumento nuoroda / Document reference

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Profilio turinio peržiūra

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

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... Slices for identifier 1..* Identifier Business identifiers for the document
Slice: Unordered, Open by value:system
.... identifier:DocumentNumber S 1..1 Identifier Dokumento numeris / Document number
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://esveikata.lt/Identifier/DocumentNumber
..... value 1..1 string LYY-XXXXXXXXX formatas, kur YY - dokumento sukūrimo metų paskutiniai 2 skaitmenys, XXXXXXXXX - 9 skaitmenų dokumento eilės numeris, dokumento sukūrimo metais / LYY-XXXXXXXXX format: YY - last 2 digits of the calendar year when the document was created, XXXXXXXXX - 9 digit document serial number in the year document was created
... version S 1..1 string Versijos numeris / Version number
... status S 1..1 code current - Dabartinė dokumento nuoroda / This is the current reference for this document. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error.
Binding: DocumentReferenceStatuses (required)
... date S 1..1 instant Dokumento nuorodos sukūrimo laikas / When this document reference was created
... author S 0..1 Reference(LtPractitionerRole) Dokumento autorius / Who authored the document
... content S 1..* BackboneElement Dokumento turinys / Document content
.... attachment S 1..1 Attachment Kur rasti dokumentą / Where to access the document
..... contentType S 0..1 code Dokumento failo Mime tipas / Mime type of the content, with charset
..... data S 0..1 base64Binary Dokumento duomenys / Data
..... title S 0..1 string Documento failo pavadinimas / Document file name

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatuses 📦0.3.31 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: docRef-1, docRef-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier:DocumentNumber SΣ 1..1 Identifier Dokumento numeris / Document number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://esveikata.lt/Identifier/DocumentNumber
..... value ΣC 1..1 string LYY-XXXXXXXXX formatas, kur YY - dokumento sukūrimo metų paskutiniai 2 skaitmenys, XXXXXXXXX - 9 skaitmenų dokumento eilės numeris, dokumento sukūrimo metais / LYY-XXXXXXXXX format: YY - last 2 digits of the calendar year when the document was created, XXXXXXXXX - 9 digit document serial number in the year document was created
Example General: 123456
... version SΣ 1..1 string Versijos numeris / Version number
... status ?!SΣ 1..1 code current - Dabartinė dokumento nuoroda / This is the current reference for this document. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error.
Binding: DocumentReferenceStatuses (required)
... subject SΣ 1..1 Reference(E200Composition) Resursas, kuriam yra priskirtas dokumentas / Who/what is the subject of the document
... context C 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... date SΣ 1..1 instant Dokumento nuorodos sukūrimo laikas / When this document reference was created
... author SΣ 0..1 Reference(LtPractitionerRole) Dokumento autorius / Who authored the document
... content SΣ 1..* BackboneElement Dokumento turinys / Document content
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Kur rasti dokumentą / Where to access the document
..... contentType SΣC 0..1 code Dokumento failo Mime tipas / Mime type of the content, with charset
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
..... data SC 0..1 base64Binary Dokumento duomenys / Data
..... title SΣ 0..1 string Documento failo pavadinimas / Document file name
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.identifier:DocumentNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatuses 📦0.3.31 This IG
DocumentReference.content.​attachment.contentType Base required Mime Types 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: docRef-1, docRef-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Business identifiers for the document
Slice: Unordered, Open by value:system
.... identifier:DocumentNumber SΣ 1..1 Identifier Dokumento numeris / Document number
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://esveikata.lt/Identifier/DocumentNumber
..... value ΣC 1..1 string LYY-XXXXXXXXX formatas, kur YY - dokumento sukūrimo metų paskutiniai 2 skaitmenys, XXXXXXXXX - 9 skaitmenų dokumento eilės numeris, dokumento sukūrimo metais / LYY-XXXXXXXXX format: YY - last 2 digits of the calendar year when the document was created, XXXXXXXXX - 9 digit document serial number in the year document was created
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... version SΣ 1..1 string Versijos numeris / Version number
... basedOn 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) Procedure that caused this media to be created
... status ?!SΣ 1..1 code current - Dabartinė dokumento nuoroda / This is the current reference for this document. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error.
Binding: DocumentReferenceStatuses (required)
... docStatus Σ 0..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.
... modality Σ 0..* CodeableConcept Imaging modality used
Binding: Modality . (extensible): Type of acquired data in the instance.
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.
... category Σ 0..* CodeableConcept Categorization of document
Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level.
... subject SΣ 1..1 Reference(E200Composition) Resursas, kuriam yra priskirtas dokumentas / Who/what is the subject of the document
... context C 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... event 0..* CodeableReference() Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
... bodySite Σ 0..* CodeableReference(BodyStructure) Body part included
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
... facilityType C 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
... practiceSetting C 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).
... period Σ 0..1 Period Time of service that is being documented
... date SΣ 1..1 instant Dokumento nuorodos sukūrimo laikas / When this document reference was created
... author SΣ 0..1 Reference(LtPractitionerRole) Dokumento autorius / Who authored the document
... attester 0..* BackboneElement Attests to accuracy of the 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
.... mode 1..1 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.
.... time 0..1 dateTime When the document was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested 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 CodeableConcept The relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 markdown Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..* BackboneElement Dokumento turinys / Document content
.... 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 Kur rasti dokumentą / Where to access the document
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣC 0..1 code Dokumento failo Mime tipas / Mime type of the content, with charset
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
..... data SC 0..1 base64Binary Dokumento duomenys / Data
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 integer64 Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 0..1 string Documento failo pavadinimas / Document file name
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
..... height 0..1 positiveInt Height of the image in pixels (photo/video)
..... width 0..1 positiveInt Width of the image in pixels (photo/video)
..... frames 0..1 positiveInt Number of frames if > 1 (photo)
..... duration 0..1 decimal Length in seconds (audio / video)
..... pages 0..1 positiveInt Number of printed pages
.... profile Σ 0..* BackboneElement Content profile rules for the 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
..... value[x] Σ 1..1 Code|uri|canonical
Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes.
...... valueCoding Coding
...... valueUri uri
...... valueCanonical canonical(Any)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.identifier:DocumentNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
DocumentReference.identifier:DocumentNumber.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatuses 📦0.3.31 This IG
DocumentReference.docStatus Base required Composition Status 📍5.0.0 FHIR Std.
DocumentReference.modality Base extensible Modality . ⏿2025.3.20250714 tx.fhir.org
DocumentReference.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
DocumentReference.category Base example Referenced Item Category Value Set 📍5.0.0 FHIR Std.
DocumentReference.event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
DocumentReference.bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
DocumentReference.facilityType Base example Facility Type Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.practiceSetting Base example Practice Setting Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
DocumentReference.relatesTo.​code Base extensible Document Relationship Type 📍5.0.0 FHIR Std.
DocumentReference.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.contentType Base required Mime Types 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.content.​profile.value[x] Base preferred HL7 ValueSet of Format Codes for use with Document Sharing 📦2.1.0 THO v7.0

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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: 9 elements
Must-Support: 11 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DocumentReference.identifier

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... Slices for identifier 1..* Identifier Business identifiers for the document
Slice: Unordered, Open by value:system
.... identifier:DocumentNumber S 1..1 Identifier Dokumento numeris / Document number
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://esveikata.lt/Identifier/DocumentNumber
..... value 1..1 string LYY-XXXXXXXXX formatas, kur YY - dokumento sukūrimo metų paskutiniai 2 skaitmenys, XXXXXXXXX - 9 skaitmenų dokumento eilės numeris, dokumento sukūrimo metais / LYY-XXXXXXXXX format: YY - last 2 digits of the calendar year when the document was created, XXXXXXXXX - 9 digit document serial number in the year document was created
... version S 1..1 string Versijos numeris / Version number
... status S 1..1 code current - Dabartinė dokumento nuoroda / This is the current reference for this document. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error.
Binding: DocumentReferenceStatuses (required)
... date S 1..1 instant Dokumento nuorodos sukūrimo laikas / When this document reference was created
... author S 0..1 Reference(LtPractitionerRole) Dokumento autorius / Who authored the document
... content S 1..* BackboneElement Dokumento turinys / Document content
.... attachment S 1..1 Attachment Kur rasti dokumentą / Where to access the document
..... contentType S 0..1 code Dokumento failo Mime tipas / Mime type of the content, with charset
..... data S 0..1 base64Binary Dokumento duomenys / Data
..... title S 0..1 string Documento failo pavadinimas / Document file name

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatuses 📦0.3.31 This IG

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: docRef-1, docRef-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier:DocumentNumber SΣ 1..1 Identifier Dokumento numeris / Document number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://esveikata.lt/Identifier/DocumentNumber
..... value ΣC 1..1 string LYY-XXXXXXXXX formatas, kur YY - dokumento sukūrimo metų paskutiniai 2 skaitmenys, XXXXXXXXX - 9 skaitmenų dokumento eilės numeris, dokumento sukūrimo metais / LYY-XXXXXXXXX format: YY - last 2 digits of the calendar year when the document was created, XXXXXXXXX - 9 digit document serial number in the year document was created
Example General: 123456
... version SΣ 1..1 string Versijos numeris / Version number
... status ?!SΣ 1..1 code current - Dabartinė dokumento nuoroda / This is the current reference for this document. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error.
Binding: DocumentReferenceStatuses (required)
... subject SΣ 1..1 Reference(E200Composition) Resursas, kuriam yra priskirtas dokumentas / Who/what is the subject of the document
... context C 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... date SΣ 1..1 instant Dokumento nuorodos sukūrimo laikas / When this document reference was created
... author SΣ 0..1 Reference(LtPractitionerRole) Dokumento autorius / Who authored the document
... content SΣ 1..* BackboneElement Dokumento turinys / Document content
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Kur rasti dokumentą / Where to access the document
..... contentType SΣC 0..1 code Dokumento failo Mime tipas / Mime type of the content, with charset
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
..... data SC 0..1 base64Binary Dokumento duomenys / Data
..... title SΣ 0..1 string Documento failo pavadinimas / Document file name
Example General: Official Corporate Logo

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.identifier:DocumentNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatuses 📦0.3.31 This IG
DocumentReference.content.​attachment.contentType Base required Mime Types 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: docRef-1, docRef-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Business identifiers for the document
Slice: Unordered, Open by value:system
.... identifier:DocumentNumber SΣ 1..1 Identifier Dokumento numeris / Document number
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://esveikata.lt/Identifier/DocumentNumber
..... value ΣC 1..1 string LYY-XXXXXXXXX formatas, kur YY - dokumento sukūrimo metų paskutiniai 2 skaitmenys, XXXXXXXXX - 9 skaitmenų dokumento eilės numeris, dokumento sukūrimo metais / LYY-XXXXXXXXX format: YY - last 2 digits of the calendar year when the document was created, XXXXXXXXX - 9 digit document serial number in the year document was created
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... version SΣ 1..1 string Versijos numeris / Version number
... basedOn 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) Procedure that caused this media to be created
... status ?!SΣ 1..1 code current - Dabartinė dokumento nuoroda / This is the current reference for this document. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error.
Binding: DocumentReferenceStatuses (required)
... docStatus Σ 0..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.
... modality Σ 0..* CodeableConcept Imaging modality used
Binding: Modality . (extensible): Type of acquired data in the instance.
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.
... category Σ 0..* CodeableConcept Categorization of document
Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level.
... subject SΣ 1..1 Reference(E200Composition) Resursas, kuriam yra priskirtas dokumentas / Who/what is the subject of the document
... context C 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... event 0..* CodeableReference() Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
... bodySite Σ 0..* CodeableReference(BodyStructure) Body part included
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
... facilityType C 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
... practiceSetting C 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).
... period Σ 0..1 Period Time of service that is being documented
... date SΣ 1..1 instant Dokumento nuorodos sukūrimo laikas / When this document reference was created
... author SΣ 0..1 Reference(LtPractitionerRole) Dokumento autorius / Who authored the document
... attester 0..* BackboneElement Attests to accuracy of the 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
.... mode 1..1 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.
.... time 0..1 dateTime When the document was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested 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 CodeableConcept The relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 markdown Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..* BackboneElement Dokumento turinys / Document content
.... 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 Kur rasti dokumentą / Where to access the document
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣC 0..1 code Dokumento failo Mime tipas / Mime type of the content, with charset
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
..... data SC 0..1 base64Binary Dokumento duomenys / Data
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 integer64 Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 0..1 string Documento failo pavadinimas / Document file name
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
..... height 0..1 positiveInt Height of the image in pixels (photo/video)
..... width 0..1 positiveInt Width of the image in pixels (photo/video)
..... frames 0..1 positiveInt Number of frames if > 1 (photo)
..... duration 0..1 decimal Length in seconds (audio / video)
..... pages 0..1 positiveInt Number of printed pages
.... profile Σ 0..* BackboneElement Content profile rules for the 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
..... value[x] Σ 1..1 Code|uri|canonical
Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes.
...... valueCoding Coding
...... valueUri uri
...... valueCanonical canonical(Any)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.identifier:DocumentNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
DocumentReference.identifier:DocumentNumber.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatuses 📦0.3.31 This IG
DocumentReference.docStatus Base required Composition Status 📍5.0.0 FHIR Std.
DocumentReference.modality Base extensible Modality . ⏿2025.3.20250714 tx.fhir.org
DocumentReference.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
DocumentReference.category Base example Referenced Item Category Value Set 📍5.0.0 FHIR Std.
DocumentReference.event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
DocumentReference.bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
DocumentReference.facilityType Base example Facility Type Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.practiceSetting Base example Practice Setting Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
DocumentReference.relatesTo.​code Base extensible Document Relationship Type 📍5.0.0 FHIR Std.
DocumentReference.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.contentType Base required Mime Types 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.content.​profile.value[x] Base preferred HL7 ValueSet of Format Codes for use with Document Sharing 📦2.1.0 THO v7.0

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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: 9 elements
Must-Support: 11 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DocumentReference.identifier

 

Other representations of profile: CSV, Excel, Schematron