eLab posistemės integracijos dokumentacija
0.3.13 - versija
eLab posistemės integracijos dokumentacija - Local Development build (v0.3.13) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://esveikata.lt/fhir/StructureDefinition/lt-documentReference | Version: 0.3.13 | |||
Active as of 2025-01-07 | Computable Name: LtDocumentReference |
Dokumento nuoroda / Document reference
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Dokumento numeris / Document number |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: http://esveikata.lt/Identifier/DocumentNumber | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
S | 1..1 | string | Versijos numeris / Version number |
![]() ![]() ![]() |
S | 1..1 | code | current - Dabartinė dokumento nuoroda / This is the current reference for this document. superseded - Ši dokumento nuoroda buvo pakeista naujesne dokumento nuoroda / This reference has been superseded by another reference. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error. |
![]() ![]() ![]() |
S | 1..1 | Reference(E200Composition) | Resursas, kuriam yra priskirtas dokumentas / Who/what is the subject of the document |
![]() ![]() ![]() |
S | 1..1 | instant | Dokumento nuorodos sukūrimo laikas / When this document reference was created |
![]() ![]() ![]() |
S | 0..1 | Reference(LtPractitionerRole) | Dokumento autorius / Who authored the document |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Dokumento turinys / Document content |
![]() ![]() ![]() ![]() |
S | 1..1 | Attachment | Kur rasti dokumentą / Where to access the document |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Dokumento failo Mime tipas / Mime type of the content, with charset |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Dokumento duomenys / Data |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Documento failo pavadinimas / Document file name |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | DocumentReference | A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Dokumento numeris / Document number ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://esveikata.lt/Identifier/DocumentNumber |
![]() ![]() ![]() ![]() ![]() |
Σ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 ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() |
SΣ | 1..1 | string | Versijos numeris / Version number ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current - Dabartinė dokumento nuoroda / This is the current reference for this document. superseded - Ši dokumento nuoroda buvo pakeista naujesne dokumento nuoroda / This reference has been superseded by another reference. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error. Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(E200Composition) | Resursas, kuriam yra priskirtas dokumentas / Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | instant | Dokumento nuorodos sukūrimo laikas / When this document reference was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(LtPractitionerRole) | Dokumento autorius / Who authored the document ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Dokumento turinys / Document content ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Kur rasti dokumentą / Where to access the document ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
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) ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Dokumento duomenys / Data ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Documento failo pavadinimas / Document file name ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.identifier:DocumentNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard | |
DocumentReference.content.attachment.contentType | required | MimeTypes (a valid code from Mime Type work-a-round)http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | DocumentReference | A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Dokumento numeris / Document number | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://esveikata.lt/Identifier/DocumentNumber | ||||
![]() ![]() ![]() ![]() ![]() |
Σ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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Versijos numeris / Version number | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current - Dabartinė dokumento nuoroda / This is the current reference for this document. superseded - Ši dokumento nuoroda buvo pakeista naujesne dokumento nuoroda / This reference has been superseded by another reference. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error. Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Imaging modality used Binding: Modality ![]() | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Categorization of document Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(E200Composition) | Resursas, kuriam yra priskirtas dokumentas / Who/what is the subject of the document | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | ||||
![]() ![]() ![]() |
0..* | CodeableReference() | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReference(BodyStructure) | Body part included Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() ![]() |
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). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() |
SΣ | 1..1 | instant | Dokumento nuorodos sukūrimo laikas / When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(LtPractitionerRole) | Dokumento autorius / Who authored the document | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Attests to accuracy of the document | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When the document was attested | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Dokumento turinys / Document content | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Kur rasti dokumentą / Where to access the document | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Dokumento duomenys / Data | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | integer64 | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Documento failo pavadinimas / Document file name Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of printed pages | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Content profile rules for the document | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
DocumentReference.identifier:DocumentNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
DocumentReference.identifier:DocumentNumber.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard | |
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard | |
DocumentReference.modality | extensible | Modality ![]() http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html | |
DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
DocumentReference.category | example | ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-category from the FHIR Standard | |
DocumentReference.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
DocumentReference.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | |
DocumentReference.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | |
DocumentReference.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard | |
DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard | |
DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examples from the FHIR Standard | |
DocumentReference.content.attachment.contentType | required | MimeTypes (a valid code from Mime Type work-a-round)http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 from the FHIR Standard | |
DocumentReference.content.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
DocumentReference.content.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
Id | Grade | Path(s) | Details | Requirements |
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:
Differential View
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Dokumento numeris / Document number |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: http://esveikata.lt/Identifier/DocumentNumber | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
S | 1..1 | string | Versijos numeris / Version number |
![]() ![]() ![]() |
S | 1..1 | code | current - Dabartinė dokumento nuoroda / This is the current reference for this document. superseded - Ši dokumento nuoroda buvo pakeista naujesne dokumento nuoroda / This reference has been superseded by another reference. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error. |
![]() ![]() ![]() |
S | 1..1 | Reference(E200Composition) | Resursas, kuriam yra priskirtas dokumentas / Who/what is the subject of the document |
![]() ![]() ![]() |
S | 1..1 | instant | Dokumento nuorodos sukūrimo laikas / When this document reference was created |
![]() ![]() ![]() |
S | 0..1 | Reference(LtPractitionerRole) | Dokumento autorius / Who authored the document |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Dokumento turinys / Document content |
![]() ![]() ![]() ![]() |
S | 1..1 | Attachment | Kur rasti dokumentą / Where to access the document |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Dokumento failo Mime tipas / Mime type of the content, with charset |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Dokumento duomenys / Data |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Documento failo pavadinimas / Document file name |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | DocumentReference | A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Dokumento numeris / Document number ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://esveikata.lt/Identifier/DocumentNumber |
![]() ![]() ![]() ![]() ![]() |
Σ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 ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() |
SΣ | 1..1 | string | Versijos numeris / Version number ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current - Dabartinė dokumento nuoroda / This is the current reference for this document. superseded - Ši dokumento nuoroda buvo pakeista naujesne dokumento nuoroda / This reference has been superseded by another reference. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error. Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(E200Composition) | Resursas, kuriam yra priskirtas dokumentas / Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | instant | Dokumento nuorodos sukūrimo laikas / When this document reference was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(LtPractitionerRole) | Dokumento autorius / Who authored the document ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Dokumento turinys / Document content ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Kur rasti dokumentą / Where to access the document ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
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) ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Dokumento duomenys / Data ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Documento failo pavadinimas / Document file name ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.identifier:DocumentNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard | |
DocumentReference.content.attachment.contentType | required | MimeTypes (a valid code from Mime Type work-a-round)http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | DocumentReference | A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Dokumento numeris / Document number | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://esveikata.lt/Identifier/DocumentNumber | ||||
![]() ![]() ![]() ![]() ![]() |
Σ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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Versijos numeris / Version number | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current - Dabartinė dokumento nuoroda / This is the current reference for this document. superseded - Ši dokumento nuoroda buvo pakeista naujesne dokumento nuoroda / This reference has been superseded by another reference. entered-in-error - Dokumento nuoroda buvo sukurta per klaidą / This reference was created in error. Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Imaging modality used Binding: Modality ![]() | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Categorization of document Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(E200Composition) | Resursas, kuriam yra priskirtas dokumentas / Who/what is the subject of the document | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | ||||
![]() ![]() ![]() |
0..* | CodeableReference() | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReference(BodyStructure) | Body part included Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() ![]() |
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). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() |
SΣ | 1..1 | instant | Dokumento nuorodos sukūrimo laikas / When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(LtPractitionerRole) | Dokumento autorius / Who authored the document | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Attests to accuracy of the document | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When the document was attested | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Dokumento turinys / Document content | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Kur rasti dokumentą / Where to access the document | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Dokumento duomenys / Data | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | integer64 | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Documento failo pavadinimas / Document file name Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of printed pages | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Content profile rules for the document | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
DocumentReference.identifier:DocumentNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
DocumentReference.identifier:DocumentNumber.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard | |
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard | |
DocumentReference.modality | extensible | Modality ![]() http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html | |
DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
DocumentReference.category | example | ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-category from the FHIR Standard | |
DocumentReference.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
DocumentReference.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | |
DocumentReference.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | |
DocumentReference.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard | |
DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard | |
DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examples from the FHIR Standard | |
DocumentReference.content.attachment.contentType | required | MimeTypes (a valid code from Mime Type work-a-round)http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 from the FHIR Standard | |
DocumentReference.content.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
DocumentReference.content.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
Id | Grade | Path(s) | Details | Requirements |
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:
Other representations of profile: CSV, Excel, Schematron