Inera Core Implementation Guide
0.2.0 - ci-build
Sweden
Inera Core Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://inera.se/fhir/core/StructureDefinition/documentreference-base-inera | Version: 0.2.0 | |||
| Draft as of 2025-11-24 | Computable Name: DocumentReferenceBaseInera | |||
Svensk profil för vårdkontaktanteckningar och kliniska dokument baserad på TKB GetCareDocumentation v2.0.
Används för:
Källa: TKB GetCareDocumentation v2.0 (clinicalprocess:healthcond:description)
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..* | DocumentReference | A reference to a document | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..1 | Identifier | Dokument-ID |
![]() ![]() |
SΣ | 0..* | Identifier | Övriga identifierare |
![]() ![]() |
?!SΣ | 1..1 | code | Status Binding: DocumentReferenceStatus (required) |
![]() ![]() |
SΣ | 0..1 | code | Dokumentstatus Binding: CompositionStatus (required) |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Dokumenttyp Binding: DocumentTypeValueSet (preferred) |
![]() ![]() ![]() |
SΣ | 0..1 | string | Dokumenttyp (text) |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Dokumentkategori Binding: DocumentClassValueSet (extensible) |
![]() ![]() |
SΣ | 1..1 | Reference(Patient Base Inera) | Patient |
![]() ![]() |
SΣ | 0..1 | instant | Vårdtillfälle/dokumentdatum |
![]() ![]() |
SΣ | 0..* | Reference(PractitionerRole Base Inera | Device | Patient Base Inera | RelatedPerson | Organization Base Inera) | Författare |
![]() ![]() |
S | 0..1 | Reference(PractitionerRole Base Inera | Organization Base Inera) | Attestant |
![]() ![]() |
S | 0..1 | Reference(Organization Base Inera) | Vårdgivare |
![]() ![]() |
SΣ | 0..* | BackboneElement | Relation till annat dokument |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | code | Relationstyp Binding: DocumentRelationshipType (required): The type of relationship between documents. |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(DocumentReference) | Relaterat dokument |
![]() ![]() |
SΣ | 0..1 | string | Beskrivning |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Säkerhetsklassificering Binding: All Security Labels (extensible) |
![]() ![]() |
SΣ | 1..* | BackboneElement | Dokumentinnehåll |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Dokumentfil |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | MIME-typ 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 |
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Dokumentdata (base64) |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Dokument-URL Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Skapandedatum |
![]() ![]() ![]() |
SΣ | 0..1 | Coding | Dokumentformat Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. |
![]() ![]() |
SΣ | 0..1 | BackboneElement | Vårdkontext |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..* | Reference(Encounter Base Inera) | Vårdkontakt |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Vårdhändelse Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. |
![]() ![]() ![]() |
SΣ | 0..1 | Period | Tidsperiod |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Vårdtyp Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Verksamhetsområde Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). |
![]() ![]() ![]() |
S | 0..1 | Reference(Patient Base Inera) | Patientinformation från källan |
![]() ![]() ![]() |
S | 0..* | Reference(Resource) | Relaterade resurser |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | extensible | Document Class Value Set | 📦4.0.1 | FHIR Std. |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📦4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| 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 DocumentReference
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | extensible | Document Class Value Set | 📦4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DocumentReference | 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 | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..1 | Identifier | Dokument-ID | ||||
![]() ![]() |
SΣ | 0..* | Identifier | Övriga identifierare | ||||
![]() ![]() |
?!SΣ | 1..1 | code | Status Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() |
SΣ | 0..1 | code | Dokumentstatus Binding: CompositionStatus (required) | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Dokumenttyp Binding: DocumentTypeValueSet (preferred) | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Dokumenttyp (text) | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Dokumentkategori Binding: DocumentClassValueSet (extensible) | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Patient Base Inera) | Patient | ||||
![]() ![]() |
SΣ | 0..1 | instant | Vårdtillfälle/dokumentdatum | ||||
![]() ![]() |
SΣ | 0..* | Reference(PractitionerRole Base Inera | Device | Patient Base Inera | RelatedPerson | Organization Base Inera) | Författare | ||||
![]() ![]() |
S | 0..1 | Reference(PractitionerRole Base Inera | Organization Base Inera) | Attestant | ||||
![]() ![]() |
S | 0..1 | Reference(Organization Base Inera) | Vårdgivare | ||||
![]() ![]() |
SΣ | 0..* | BackboneElement | Relation till annat dokument | ||||
![]() ![]() ![]() |
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 | code | Relationstyp Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(DocumentReference) | Relaterat dokument | ||||
![]() ![]() |
SΣ | 0..1 | string | Beskrivning | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Säkerhetsklassificering Binding: All Security Labels (extensible) | ||||
![]() ![]() |
SΣ | 1..* | BackboneElement | Dokumentinnehåll | ||||
![]() ![]() ![]() |
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 | Dokumentfil | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | MIME-typ 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 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Dokumentdata (base64) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Dokument-URL 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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Skapandedatum | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Coding | Dokumentformat Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
![]() ![]() |
SΣ | 0..1 | BackboneElement | Vårdkontext | ||||
![]() ![]() ![]() |
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 | 0..* | Reference(Encounter Base Inera) | Vårdkontakt | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Vårdhändelse Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | Tidsperiod | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Vårdtyp Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Verksamhetsområde Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Patient Base Inera) | Patientinformation från källan | ||||
![]() ![]() ![]() |
S | 0..* | Reference(Resource) | Relaterade resurser | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.language | Base | preferred | Common Languages | 📍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 | extensible | Document Class Value Set | 📦4.0.1 | FHIR Std. |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📦4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| 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 DocumentReference
Summary
Mandatory: 3 elements
Must-Support: 32 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..1 | Identifier | Dokument-ID |
![]() ![]() |
SΣ | 0..* | Identifier | Övriga identifierare |
![]() ![]() |
?!SΣ | 1..1 | code | Status Binding: DocumentReferenceStatus (required) |
![]() ![]() |
SΣ | 0..1 | code | Dokumentstatus Binding: CompositionStatus (required) |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Dokumenttyp Binding: DocumentTypeValueSet (preferred) |
![]() ![]() ![]() |
SΣ | 0..1 | string | Dokumenttyp (text) |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Dokumentkategori Binding: DocumentClassValueSet (extensible) |
![]() ![]() |
SΣ | 1..1 | Reference(Patient Base Inera) | Patient |
![]() ![]() |
SΣ | 0..1 | instant | Vårdtillfälle/dokumentdatum |
![]() ![]() |
SΣ | 0..* | Reference(PractitionerRole Base Inera | Device | Patient Base Inera | RelatedPerson | Organization Base Inera) | Författare |
![]() ![]() |
S | 0..1 | Reference(PractitionerRole Base Inera | Organization Base Inera) | Attestant |
![]() ![]() |
S | 0..1 | Reference(Organization Base Inera) | Vårdgivare |
![]() ![]() |
SΣ | 0..* | BackboneElement | Relation till annat dokument |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | code | Relationstyp Binding: DocumentRelationshipType (required): The type of relationship between documents. |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(DocumentReference) | Relaterat dokument |
![]() ![]() |
SΣ | 0..1 | string | Beskrivning |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Säkerhetsklassificering Binding: All Security Labels (extensible) |
![]() ![]() |
SΣ | 1..* | BackboneElement | Dokumentinnehåll |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Dokumentfil |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | MIME-typ 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 |
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Dokumentdata (base64) |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Dokument-URL Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Skapandedatum |
![]() ![]() ![]() |
SΣ | 0..1 | Coding | Dokumentformat Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. |
![]() ![]() |
SΣ | 0..1 | BackboneElement | Vårdkontext |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..* | Reference(Encounter Base Inera) | Vårdkontakt |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Vårdhändelse Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. |
![]() ![]() ![]() |
SΣ | 0..1 | Period | Tidsperiod |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Vårdtyp Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Verksamhetsområde Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). |
![]() ![]() ![]() |
S | 0..1 | Reference(Patient Base Inera) | Patientinformation från källan |
![]() ![]() ![]() |
S | 0..* | Reference(Resource) | Relaterade resurser |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | extensible | Document Class Value Set | 📦4.0.1 | FHIR Std. |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📦4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| 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()
|
Differential View
This structure is derived from DocumentReference
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | extensible | Document Class Value Set | 📦4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DocumentReference | 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 | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..1 | Identifier | Dokument-ID | ||||
![]() ![]() |
SΣ | 0..* | Identifier | Övriga identifierare | ||||
![]() ![]() |
?!SΣ | 1..1 | code | Status Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() |
SΣ | 0..1 | code | Dokumentstatus Binding: CompositionStatus (required) | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Dokumenttyp Binding: DocumentTypeValueSet (preferred) | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Dokumenttyp (text) | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Dokumentkategori Binding: DocumentClassValueSet (extensible) | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Patient Base Inera) | Patient | ||||
![]() ![]() |
SΣ | 0..1 | instant | Vårdtillfälle/dokumentdatum | ||||
![]() ![]() |
SΣ | 0..* | Reference(PractitionerRole Base Inera | Device | Patient Base Inera | RelatedPerson | Organization Base Inera) | Författare | ||||
![]() ![]() |
S | 0..1 | Reference(PractitionerRole Base Inera | Organization Base Inera) | Attestant | ||||
![]() ![]() |
S | 0..1 | Reference(Organization Base Inera) | Vårdgivare | ||||
![]() ![]() |
SΣ | 0..* | BackboneElement | Relation till annat dokument | ||||
![]() ![]() ![]() |
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 | code | Relationstyp Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(DocumentReference) | Relaterat dokument | ||||
![]() ![]() |
SΣ | 0..1 | string | Beskrivning | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Säkerhetsklassificering Binding: All Security Labels (extensible) | ||||
![]() ![]() |
SΣ | 1..* | BackboneElement | Dokumentinnehåll | ||||
![]() ![]() ![]() |
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 | Dokumentfil | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | MIME-typ 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 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Dokumentdata (base64) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Dokument-URL 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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Skapandedatum | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Coding | Dokumentformat Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
![]() ![]() |
SΣ | 0..1 | BackboneElement | Vårdkontext | ||||
![]() ![]() ![]() |
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 | 0..* | Reference(Encounter Base Inera) | Vårdkontakt | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Vårdhändelse Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | Tidsperiod | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Vårdtyp Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Verksamhetsområde Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Patient Base Inera) | Patientinformation från källan | ||||
![]() ![]() ![]() |
S | 0..* | Reference(Resource) | Relaterade resurser | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.language | Base | preferred | Common Languages | 📍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 | extensible | Document Class Value Set | 📦4.0.1 | FHIR Std. |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📦4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.0 |
| 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 DocumentReference
Summary
Mandatory: 3 elements
Must-Support: 32 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron