HL7 Czech Imaging Report IG
0.1.0-ballot - ci-build
HL7 Czech Imaging Report IG, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/img/ and changes regularly. See the Directory of published versions
Official URL: https://hl7.cz/fhir/img/StructureDefinition/cz-keyImageDocumentReference-obl-img | Version: 0.1.0-ballot | |||
Draft as of 2025-10-03 | Computable Name: CZ_KeyImageDocumentReferenceObligationsImg |
This profile defines obligations for a key image document reference in FHIR for the purpose of this guide.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CZ_KeyImageDocumentReference | A reference to a document | |||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url, value:value | |||||||||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Appointment | AppointmentResponse | Care plan: Imaging Report (CZ) | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | SupplyRequest | VisionPrescription | Service Request: Imaging Report (CZ)) | Value of extension | |||||||||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Service Request: Imaging Report (CZ)) | Value of extension | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CZ_AccessionNumberIdentifier | Logical reference, when literal reference is not known | ||||||||||
![]() ![]() ![]() ![]() |
O | 1..1 | (Complex) | DocumentReference.modality extension for R4 URL: https://hl7.cz/fhir/img/StructureDefinition/modality-cz
| ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://hl7.cz/fhir/img/StructureDefinition/modality-cz" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note
| ||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | CodeableConcept | Media.view extension URL: https://hl7.cz/fhir/img/StructureDefinition/CrossVersionMediaViewExtension Binding: Media View types - placeholder for cross-version extension (required)
| ||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:$this | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Other identifiers for the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://hl7.cz/fhir/img/CodeSystem/codesystem-missing-dicom-terminology | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Other identifiers for the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||||||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||||||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by profile:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 55113-5 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Key images Document Radiology | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient (CZ core) | Patient: Animal (CZ)) | Who/what is the subject of the document | ||||||||||
![]() ![]() ![]() |
OΣ | 0..1 | instant | When this document reference was created
| ||||||||||
![]() ![]() ![]() |
OΣ | 0..* | Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Organization (CZ core) | Device: Performer/Observer (CZ) | Medical Device (CZ) | Patient (CZ core) | Related Person (CZ core)) | Who and/or what authored the document Slice: Unordered, Open by profile:$this
| ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Reference(Practitioner Role (CZ core)) | Who and/or what authored the document | ||||||||||
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:extension.value | ||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true | |||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Document referenced | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: false | |||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() ![]() |
OΣ | 1..1 | Attachment | Where to access the document
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||||||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
DocumentReference.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:seriesInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:sopClassInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
DocumentReference.category | Base | example | Document Class Value Set | 📍4.0.1 | FHIR Std. |
DocumentReference.category:imkeyimages | Base | example | Document Class Value Set | 📍4.0.1 | FHIR Std. |
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().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 CZ_KeyImageDocumentReference
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CZ_KeyImageDocumentReference | A reference to a document | |||||||||||
![]() ![]() ![]() |
Σ | 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: CommonLanguages (preferred): A human language.
| |||||||||||
![]() ![]() ![]() |
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 | |||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url, value:value | |||||||||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Appointment | AppointmentResponse | Care plan: Imaging Report (CZ) | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | SupplyRequest | VisionPrescription | Service Request: Imaging Report (CZ)) | Value of extension | |||||||||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Service Request: Imaging Report (CZ)) | Value of extension | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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). | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CZ_AccessionNumberIdentifier | Logical reference, when literal reference is not known | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||
![]() ![]() ![]() ![]() |
O | 1..1 | (Complex) | DocumentReference.modality extension for R4 URL: https://hl7.cz/fhir/img/StructureDefinition/modality-cz
| ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://hl7.cz/fhir/img/StructureDefinition/modality-cz" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: CZ Modality (preferred) | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note
| ||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | CodeableConcept | Media.view extension URL: https://hl7.cz/fhir/img/StructureDefinition/CrossVersionMediaViewExtension Binding: Media View types - placeholder for cross-version extension (required)
| ||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:$this | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Other identifiers for the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | 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 . | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://hl7.cz/fhir/img/CodeSystem/codesystem-missing-dicom-terminology | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization (CZ core)) | Organization that issued id (may be just text) | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Other identifiers for the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | 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 . | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization (CZ core)) | Organization that issued id (may be just text) | ||||||||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. | ||||||||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by profile:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 55113-5 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Key images Document Radiology | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient (CZ core) | Patient: Animal (CZ)) | Who/what is the subject of the document | ||||||||||
![]() ![]() ![]() |
OΣ | 0..1 | instant | When this document reference was created
| ||||||||||
![]() ![]() ![]() |
OΣ | 0..* | Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Organization (CZ core) | Device: Performer/Observer (CZ) | Medical Device (CZ) | Patient (CZ core) | Related Person (CZ core)) | Who and/or what authored the document Slice: Unordered, Open by profile:$this
| ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Reference(Practitioner Role (CZ core)) | Who and/or what authored the document | ||||||||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Organization (CZ core)) | Who/what authenticated the document | |||||||||||
![]() ![]() ![]() |
0..1 | Reference(Organization (CZ core)) | 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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||||||
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:extension.value | ||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
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 | Attachment | Where to access the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true | |||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Document referenced | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: false | |||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() ![]() |
OΣ | 1..1 | Attachment | Where to access the document
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Clinical context of 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 | ||||||||||
![]() ![]() ![]() ![]() |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||||||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented. | |||||||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | Period | Time of service that is being documented
| ||||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||||||||
![]() ![]() ![]() ![]() |
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 | Reference(Patient (CZ core) | Patient: Animal (CZ)) | Patient demographics from source | |||||||||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||||||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
DocumentReference.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
DocumentReference.extension:basedOn/imorderaccession.value[x].type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
DocumentReference.extension:modality.value[x].coding | Base | preferred | CZ Modality | 📦0.1.0-ballot | This IG |
DocumentReference.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:seriesInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:sopClassInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
DocumentReference.docStatus | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
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.category:imkeyimages | 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.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
DocumentReference.content:thumbnail.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
DocumentReference.content:content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
DocumentReference.content:content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
DocumentReference.content: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 v6.5 |
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. |
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().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 CZ_KeyImageDocumentReference
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CZ_KeyImageDocumentReference | A reference to a document | |||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url, value:value | |||||||||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Appointment | AppointmentResponse | Care plan: Imaging Report (CZ) | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | SupplyRequest | VisionPrescription | Service Request: Imaging Report (CZ)) | Value of extension | |||||||||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Service Request: Imaging Report (CZ)) | Value of extension | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CZ_AccessionNumberIdentifier | Logical reference, when literal reference is not known | ||||||||||
![]() ![]() ![]() ![]() |
O | 1..1 | (Complex) | DocumentReference.modality extension for R4 URL: https://hl7.cz/fhir/img/StructureDefinition/modality-cz
| ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://hl7.cz/fhir/img/StructureDefinition/modality-cz" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note
| ||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | CodeableConcept | Media.view extension URL: https://hl7.cz/fhir/img/StructureDefinition/CrossVersionMediaViewExtension Binding: Media View types - placeholder for cross-version extension (required)
| ||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:$this | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Other identifiers for the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://hl7.cz/fhir/img/CodeSystem/codesystem-missing-dicom-terminology | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Other identifiers for the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||||||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||||||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by profile:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 55113-5 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Key images Document Radiology | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient (CZ core) | Patient: Animal (CZ)) | Who/what is the subject of the document | ||||||||||
![]() ![]() ![]() |
OΣ | 0..1 | instant | When this document reference was created
| ||||||||||
![]() ![]() ![]() |
OΣ | 0..* | Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Organization (CZ core) | Device: Performer/Observer (CZ) | Medical Device (CZ) | Patient (CZ core) | Related Person (CZ core)) | Who and/or what authored the document Slice: Unordered, Open by profile:$this
| ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Reference(Practitioner Role (CZ core)) | Who and/or what authored the document | ||||||||||
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:extension.value | ||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true | |||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Document referenced | ||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: false | |||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() ![]() |
OΣ | 1..1 | Attachment | Where to access the document
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||||||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
DocumentReference.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:seriesInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:sopClassInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
DocumentReference.category | Base | example | Document Class Value Set | 📍4.0.1 | FHIR Std. |
DocumentReference.category:imkeyimages | Base | example | Document Class Value Set | 📍4.0.1 | FHIR Std. |
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().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 CZ_KeyImageDocumentReference
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CZ_KeyImageDocumentReference | A reference to a document | |||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() |
O | 1..1 | ModalityCz | DocumentReference.modality extension for R4
| ||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | Note(5.2.0) | Additional notes that apply to this resource or element.
| ||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | CrossVersionMediaViewExtension | Media.view extension
| ||||||||||
![]() ![]() ![]() |
O | 0..1 | instant | When this document reference was created
| ||||||||||
![]() ![]() ![]() |
O | 0..* | Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Organization (CZ core) | Device: Performer/Observer (CZ) | Medical Device (CZ) | Patient (CZ core) | Related Person (CZ core)) | Who and/or what authored the document
| ||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Document referenced | |||||||||||
![]() ![]() ![]() ![]() ![]() |
O | 1..1 | Attachment | Where to access the document
| ||||||||||
![]() ![]() ![]() |
||||||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | Period | Time of service that is being documented
| ||||||||||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CZ_KeyImageDocumentReference | A reference to a document | |||||||||||
![]() ![]() ![]() |
Σ | 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: CommonLanguages (preferred): A human language.
| |||||||||||
![]() ![]() ![]() |
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 | |||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url, value:value | |||||||||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Appointment | AppointmentResponse | Care plan: Imaging Report (CZ) | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | SupplyRequest | VisionPrescription | Service Request: Imaging Report (CZ)) | Value of extension | |||||||||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.basedOn" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Service Request: Imaging Report (CZ)) | Value of extension | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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). | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CZ_AccessionNumberIdentifier | Logical reference, when literal reference is not known | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||
![]() ![]() ![]() ![]() |
O | 1..1 | (Complex) | DocumentReference.modality extension for R4 URL: https://hl7.cz/fhir/img/StructureDefinition/modality-cz
| ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://hl7.cz/fhir/img/StructureDefinition/modality-cz" | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: CZ Modality (preferred) | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note
| ||||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | CodeableConcept | Media.view extension URL: https://hl7.cz/fhir/img/StructureDefinition/CrossVersionMediaViewExtension Binding: Media View types - placeholder for cross-version extension (required)
| ||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:$this | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Other identifiers for the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | 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 . | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://hl7.cz/fhir/img/CodeSystem/codesystem-missing-dicom-terminology | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization (CZ core)) | Organization that issued id (may be just text) | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Other identifiers for the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | 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 . | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization (CZ core)) | Organization that issued id (may be just text) | ||||||||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. | ||||||||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by profile:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 55113-5 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Key images Document Radiology | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient (CZ core) | Patient: Animal (CZ)) | Who/what is the subject of the document | ||||||||||
![]() ![]() ![]() |
OΣ | 0..1 | instant | When this document reference was created
| ||||||||||
![]() ![]() ![]() |
OΣ | 0..* | Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Organization (CZ core) | Device: Performer/Observer (CZ) | Medical Device (CZ) | Patient (CZ core) | Related Person (CZ core)) | Who and/or what authored the document Slice: Unordered, Open by profile:$this
| ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Reference(Practitioner Role (CZ core)) | Who and/or what authored the document | ||||||||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Organization (CZ core)) | Who/what authenticated the document | |||||||||||
![]() ![]() ![]() |
0..1 | Reference(Organization (CZ core)) | 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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||||||
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:extension.value | ||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
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 | Attachment | Where to access the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true | |||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Document referenced | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: false | |||||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() ![]() |
OΣ | 1..1 | Attachment | Where to access the document
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Clinical context of 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 | ||||||||||
![]() ![]() ![]() ![]() |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||||||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented. | |||||||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | Period | Time of service that is being documented
| ||||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||||||||
![]() ![]() ![]() ![]() |
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 | Reference(Patient (CZ core) | Patient: Animal (CZ)) | Patient demographics from source | |||||||||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||||||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
DocumentReference.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
DocumentReference.extension:basedOn/imorderaccession.value[x].type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
DocumentReference.extension:modality.value[x].coding | Base | preferred | CZ Modality | 📦0.1.0-ballot | This IG |
DocumentReference.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:seriesInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
DocumentReference.identifier:sopClassInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
DocumentReference.docStatus | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
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.category:imkeyimages | 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.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
DocumentReference.content:thumbnail.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
DocumentReference.content:content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
DocumentReference.content:content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
DocumentReference.content: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 v6.5 |
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. |
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().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 CZ_KeyImageDocumentReference
Other representations of profile: CSV, Excel, Schematron