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

Resource Profile: CarePlan DocumentReference Inera

Official URL: https://inera.se/fhir/core/StructureDefinition/careplan-documentreference-inera Version: 0.2.0
Draft as of 2026-01-09 Computable Name: CarePlanDocumentReferenceInera

Svensk profil för vårdplansdokument baserad på TKB GetCarePlan v2.0.

Denna profil används för TKB GetCarePlan v2.0-tjänsten som returnerar vårdplaner som dokument (PDF, HTML, bilder) snarare än strukturerade aktiviteter. Se ConceptMap GetCarePlan TKB to FHIR DocumentReference.

Användningsområden:

  • Samordnad individuell plan (SIP)
  • Samordnad plan enligt LPT eller LRV (SPLPTLRV)
  • Samordnad plan vid utskrivning (SPU)
  • Vårdplan (VP)
  • Habiliteringsplan (HP)
  • Rehabiliteringsplan (RP)
  • Genomförandeplan (GP)
  • Standardiserad vårdplan (SVP)

Vårdplansdokument som bilagor:

  • PDF-dokument (application/pdf)
  • HTML-dokument (text/html)
  • Textdokument (text/plain)
  • Bildfiler (image/png, image/jpeg, image/tiff)

Multi-organisatorisk samordning:

  • Flera vårdenheter kan delta i samma vårdplan (context.related)
  • Stöd för samordnad vård mellan vårdgivare

Källa: TKB GetCarePlan v2.0 (clinicalprocess:logistics:logistics) ConceptMap: ConceptMapGetCarePlanTKBToDocumentReference

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier SΣ 1..1 Identifier Vårdplansdokument-ID
... identifier SΣ 0..* Identifier Ytterligare identifierare
... status ?!SΣ 1..1 code Dokumentstatus
Binding: DocumentReferenceStatus (required)
... docStatus SΣ 0..1 code Kompositionsstatus
Binding: CompositionStatus (required): Status of the underlying document.
... type SΣ 1..1 CodeableConcept Vårdplanstyp
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
.... text SΣ 0..1 string Vårdplanstyp (text)
... category SΣ 1..* CodeableConcept Dokumentkategori
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject SΣ 1..1 Reference(Patient Base Inera) Patient
... date SΣ 1..1 instant Skapad tidpunkt
... author SΣ 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera) Författare
... authenticator S 0..1 Reference(PractitionerRole Base Inera | Organization Base Inera) Signerare
... custodian S 1..1 Reference(Organization Base Inera) Dokumentansvarig vårdgivare
... relatesTo SΣ 0..* BackboneElement Relation till andra dokument
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..1 code Relationstyp
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target SΣ 1..1 Reference(DocumentReference) Relaterat dokument
... description SΣ 0..1 string Dokumenttitel
... securityLabel SΣ 0..* CodeableConcept Säkerhetsmärkning
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..* BackboneElement Dokumentinnehåll
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Bilaga
..... contentType 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
..... language SΣ 0..1 code Språk
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data S 0..1 base64Binary Inline data (base64)
..... url SΣ 0..1 url Extern URL
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Storlek (bytes)
..... hash SΣ 0..1 base64Binary Hash (SHA-1)
..... title SΣ 0..1 string Bilagetitel
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Skapad tidpunkt
.... format SΣ 0..1 Coding Dokumentformat
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context SΣ 0..1 BackboneElement Dokumentkontext
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter S 0..* Reference(Encounter Base Inera) Vårdkontakt
.... event S 0..* CodeableConcept Händelse
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period SΣ 0..1 Period Tidsperiod
.... facilityType S 0..1 CodeableConcept Vårdenhettyp
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting S 0..1 CodeableConcept Verksamhetsområde
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo S 0..1 Reference(Patient Base Inera) Patientinformation vid dokumenttillfället
.... related S 0..* Reference(Resource) Deltagande vårdenheter

doco Documentation for this format

Terminology Bindings

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 example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... masterIdentifier S 1..1 Identifier Vårdplansdokument-ID
... identifier S 0..* Identifier Ytterligare identifierare
... status S 1..1 code Dokumentstatus
Binding: DocumentReferenceStatus (required)
... docStatus S 0..1 code Kompositionsstatus
... type S 1..1 CodeableConcept Vårdplanstyp
.... coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
.... text S 0..1 string Vårdplanstyp (text)
... category S 1..* CodeableConcept Dokumentkategori
... subject S 1..1 Reference(Patient Base Inera) Patient
... date S 1..1 instant Skapad tidpunkt
... author S 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera) Författare
... authenticator S 0..1 Reference(PractitionerRole Base Inera | Organization Base Inera) Signerare
... custodian S 1..1 Reference(Organization Base Inera) Dokumentansvarig vårdgivare
... relatesTo S 0..* BackboneElement Relation till andra dokument
.... code S 1..1 code Relationstyp
.... target S 1..1 Reference(DocumentReference) Relaterat dokument
... description S 0..1 string Dokumenttitel
... securityLabel S 0..* CodeableConcept Säkerhetsmärkning
... content S 1..* BackboneElement Dokumentinnehåll
.... attachment S 1..1 Attachment Bilaga
..... contentType S 1..1 code MIME-typ
..... language S 0..1 code Språk
..... data S 0..1 base64Binary Inline data (base64)
..... url S 0..1 url Extern URL
..... size S 0..1 unsignedInt Storlek (bytes)
..... hash S 0..1 base64Binary Hash (SHA-1)
..... title S 0..1 string Bilagetitel
..... creation S 0..1 dateTime Skapad tidpunkt
.... format S 0..1 Coding Dokumentformat
... context S 0..1 BackboneElement Dokumentkontext
.... encounter S 0..* Reference(Encounter Base Inera) Vårdkontakt
.... event S 0..* CodeableConcept Händelse
.... period S 0..1 Period Tidsperiod
.... facilityType S 0..1 CodeableConcept Vårdenhettyp
.... practiceSetting S 0..1 CodeableConcept Verksamhetsområde
.... sourcePatientInfo S 0..1 Reference(Patient Base Inera) Patientinformation vid dokumenttillfället
.... related S 0..* Reference(Resource) Deltagande vårdenheter

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier SΣ 1..1 Identifier Vårdplansdokument-ID
... identifier SΣ 0..* Identifier Ytterligare identifierare
... status ?!SΣ 1..1 code Dokumentstatus
Binding: DocumentReferenceStatus (required)
... docStatus SΣ 0..1 code Kompositionsstatus
Binding: CompositionStatus (required): Status of the underlying document.
... type SΣ 1..1 CodeableConcept Vårdplanstyp
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
.... text SΣ 0..1 string Vårdplanstyp (text)
... category SΣ 1..* CodeableConcept Dokumentkategori
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject SΣ 1..1 Reference(Patient Base Inera) Patient
... date SΣ 1..1 instant Skapad tidpunkt
... author SΣ 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera) Författare
... authenticator S 0..1 Reference(PractitionerRole Base Inera | Organization Base Inera) Signerare
... custodian S 1..1 Reference(Organization Base Inera) Dokumentansvarig vårdgivare
... relatesTo SΣ 0..* BackboneElement Relation till andra dokument
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..1 code Relationstyp
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target SΣ 1..1 Reference(DocumentReference) Relaterat dokument
... description SΣ 0..1 string Dokumenttitel
... securityLabel SΣ 0..* CodeableConcept Säkerhetsmärkning
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..* BackboneElement Dokumentinnehåll
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Bilaga
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 1..1 code MIME-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
..... language SΣ 0..1 code Språk
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data S 0..1 base64Binary Inline data (base64)
..... url SΣ 0..1 url Extern URL
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Storlek (bytes)
..... hash SΣ 0..1 base64Binary Hash (SHA-1)
..... title SΣ 0..1 string Bilagetitel
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Skapad tidpunkt
.... format SΣ 0..1 Coding Dokumentformat
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context SΣ 0..1 BackboneElement Dokumentkontext
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter S 0..* Reference(Encounter Base Inera) Vårdkontakt
.... event S 0..* CodeableConcept Händelse
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period SΣ 0..1 Period Tidsperiod
.... facilityType S 0..1 CodeableConcept Vårdenhettyp
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting S 0..1 CodeableConcept Verksamhetsområde
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo S 0..1 Reference(Patient Base Inera) Patientinformation vid dokumenttillfället
.... related S 0..* Reference(Resource) Deltagande vårdenheter

doco Documentation for this format

Terminology Bindings

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 example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier SΣ 1..1 Identifier Vårdplansdokument-ID
... identifier SΣ 0..* Identifier Ytterligare identifierare
... status ?!SΣ 1..1 code Dokumentstatus
Binding: DocumentReferenceStatus (required)
... docStatus SΣ 0..1 code Kompositionsstatus
Binding: CompositionStatus (required): Status of the underlying document.
... type SΣ 1..1 CodeableConcept Vårdplanstyp
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
.... text SΣ 0..1 string Vårdplanstyp (text)
... category SΣ 1..* CodeableConcept Dokumentkategori
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject SΣ 1..1 Reference(Patient Base Inera) Patient
... date SΣ 1..1 instant Skapad tidpunkt
... author SΣ 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera) Författare
... authenticator S 0..1 Reference(PractitionerRole Base Inera | Organization Base Inera) Signerare
... custodian S 1..1 Reference(Organization Base Inera) Dokumentansvarig vårdgivare
... relatesTo SΣ 0..* BackboneElement Relation till andra dokument
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..1 code Relationstyp
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target SΣ 1..1 Reference(DocumentReference) Relaterat dokument
... description SΣ 0..1 string Dokumenttitel
... securityLabel SΣ 0..* CodeableConcept Säkerhetsmärkning
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..* BackboneElement Dokumentinnehåll
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Bilaga
..... contentType 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
..... language SΣ 0..1 code Språk
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data S 0..1 base64Binary Inline data (base64)
..... url SΣ 0..1 url Extern URL
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Storlek (bytes)
..... hash SΣ 0..1 base64Binary Hash (SHA-1)
..... title SΣ 0..1 string Bilagetitel
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Skapad tidpunkt
.... format SΣ 0..1 Coding Dokumentformat
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context SΣ 0..1 BackboneElement Dokumentkontext
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter S 0..* Reference(Encounter Base Inera) Vårdkontakt
.... event S 0..* CodeableConcept Händelse
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period SΣ 0..1 Period Tidsperiod
.... facilityType S 0..1 CodeableConcept Vårdenhettyp
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting S 0..1 CodeableConcept Verksamhetsområde
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo S 0..1 Reference(Patient Base Inera) Patientinformation vid dokumenttillfället
.... related S 0..* Reference(Resource) Deltagande vårdenheter

doco Documentation for this format

Terminology Bindings

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 example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... masterIdentifier S 1..1 Identifier Vårdplansdokument-ID
... identifier S 0..* Identifier Ytterligare identifierare
... status S 1..1 code Dokumentstatus
Binding: DocumentReferenceStatus (required)
... docStatus S 0..1 code Kompositionsstatus
... type S 1..1 CodeableConcept Vårdplanstyp
.... coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
.... text S 0..1 string Vårdplanstyp (text)
... category S 1..* CodeableConcept Dokumentkategori
... subject S 1..1 Reference(Patient Base Inera) Patient
... date S 1..1 instant Skapad tidpunkt
... author S 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera) Författare
... authenticator S 0..1 Reference(PractitionerRole Base Inera | Organization Base Inera) Signerare
... custodian S 1..1 Reference(Organization Base Inera) Dokumentansvarig vårdgivare
... relatesTo S 0..* BackboneElement Relation till andra dokument
.... code S 1..1 code Relationstyp
.... target S 1..1 Reference(DocumentReference) Relaterat dokument
... description S 0..1 string Dokumenttitel
... securityLabel S 0..* CodeableConcept Säkerhetsmärkning
... content S 1..* BackboneElement Dokumentinnehåll
.... attachment S 1..1 Attachment Bilaga
..... contentType S 1..1 code MIME-typ
..... language S 0..1 code Språk
..... data S 0..1 base64Binary Inline data (base64)
..... url S 0..1 url Extern URL
..... size S 0..1 unsignedInt Storlek (bytes)
..... hash S 0..1 base64Binary Hash (SHA-1)
..... title S 0..1 string Bilagetitel
..... creation S 0..1 dateTime Skapad tidpunkt
.... format S 0..1 Coding Dokumentformat
... context S 0..1 BackboneElement Dokumentkontext
.... encounter S 0..* Reference(Encounter Base Inera) Vårdkontakt
.... event S 0..* CodeableConcept Händelse
.... period S 0..1 Period Tidsperiod
.... facilityType S 0..1 CodeableConcept Vårdenhettyp
.... practiceSetting S 0..1 CodeableConcept Verksamhetsområde
.... sourcePatientInfo S 0..1 Reference(Patient Base Inera) Patientinformation vid dokumenttillfället
.... related S 0..* Reference(Resource) Deltagande vårdenheter

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier SΣ 1..1 Identifier Vårdplansdokument-ID
... identifier SΣ 0..* Identifier Ytterligare identifierare
... status ?!SΣ 1..1 code Dokumentstatus
Binding: DocumentReferenceStatus (required)
... docStatus SΣ 0..1 code Kompositionsstatus
Binding: CompositionStatus (required): Status of the underlying document.
... type SΣ 1..1 CodeableConcept Vårdplanstyp
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
.... text SΣ 0..1 string Vårdplanstyp (text)
... category SΣ 1..* CodeableConcept Dokumentkategori
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject SΣ 1..1 Reference(Patient Base Inera) Patient
... date SΣ 1..1 instant Skapad tidpunkt
... author SΣ 0..* Reference(PractitionerRole Base Inera | Organization Base Inera | Device | Patient Base Inera) Författare
... authenticator S 0..1 Reference(PractitionerRole Base Inera | Organization Base Inera) Signerare
... custodian S 1..1 Reference(Organization Base Inera) Dokumentansvarig vårdgivare
... relatesTo SΣ 0..* BackboneElement Relation till andra dokument
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SΣ 1..1 code Relationstyp
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target SΣ 1..1 Reference(DocumentReference) Relaterat dokument
... description SΣ 0..1 string Dokumenttitel
... securityLabel SΣ 0..* CodeableConcept Säkerhetsmärkning
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..* BackboneElement Dokumentinnehåll
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Bilaga
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 1..1 code MIME-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
..... language SΣ 0..1 code Språk
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data S 0..1 base64Binary Inline data (base64)
..... url SΣ 0..1 url Extern URL
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Storlek (bytes)
..... hash SΣ 0..1 base64Binary Hash (SHA-1)
..... title SΣ 0..1 string Bilagetitel
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Skapad tidpunkt
.... format SΣ 0..1 Coding Dokumentformat
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context SΣ 0..1 BackboneElement Dokumentkontext
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter S 0..* Reference(Encounter Base Inera) Vårdkontakt
.... event S 0..* CodeableConcept Händelse
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period SΣ 0..1 Period Tidsperiod
.... facilityType S 0..1 CodeableConcept Vårdenhettyp
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting S 0..1 CodeableConcept Verksamhetsområde
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo S 0..1 Reference(Patient Base Inera) Patientinformation vid dokumenttillfället
.... related S 0..* Reference(Resource) Deltagande vårdenheter

doco Documentation for this format

Terminology Bindings

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 example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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

 

Other representations of profile: CSV, Excel, Schematron