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
| Draft as of 2025-11-24 |
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource ------------------------------------------------------------------- a fhir:ConceptMap ; fhir:nodeRole fhir:treeRoot ; fhir:id [ fhir:v "ConceptMapGetCareDocumentationTKBToDocumentReference"] ; # fhir:text [ fhir:status [ fhir:v "generated" ] ; fhir:div [ fhir:v "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ConceptMap ConceptMapGetCareDocumentationTKBToDocumentReference</b></p><a name=\"ConceptMapGetCareDocumentationTKBToDocumentReference\"> </a><a name=\"hcConceptMapGetCareDocumentationTKBToDocumentReference\"> </a><p>Mapping from https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2 to <a href=\"http://hl7.org/fhir/R4/documentreference.html\">DocumentReference</a></p><br/><p><b>Group 1 </b>Mapping from <code>https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2</code> to <a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></p><table class=\"grid\"><tr><td><b>Source Code</b></td><td><b>Relationship</b></td><td><b>Target Code</b></td><td><b>Comment</b></td></tr><tr><td>patientId (Query parameter: Patient ID filter)</td><td colspan=\"2\" style=\"background-color: #efefef\">(not mapped)</td><td style=\"background-color: #efefef\">NOT MAPPED. Used as search parameter: GET /DocumentReference?subject=Patient/191212121212</td></tr><tr><td>careUnitHSAid (Query parameter: Filter by care unit HSA-ID)</td><td colspan=\"2\" style=\"background-color: #efefef\">(not mapped)</td><td style=\"background-color: #efefef\">NOT MAPPED. Used as search parameter: GET /DocumentReference?custodian.identifier=https://hsaid.se|SE2321000016-A001</td></tr><tr><td>sourceSystemHSAid (Query parameter: Filter by source system)</td><td colspan=\"2\" style=\"background-color: #efefef\">(not mapped)</td><td style=\"background-color: #efefef\">NOT MAPPED. Used as search parameter or routing to specific system</td></tr><tr><td>timePeriod (Query parameter: Time period filter (from-to))</td><td colspan=\"2\" style=\"background-color: #efefef\">(not mapped)</td><td style=\"background-color: #efefef\">NOT MAPPED. Used as search parameter: GET /DocumentReference?date=ge2025-01-01&date=le2025-12-31</td></tr><tr><td>careContactId (Query parameter: Filter by specific care contact)</td><td colspan=\"2\" style=\"background-color: #efefef\">(not mapped)</td><td style=\"background-color: #efefef\">NOT MAPPED. Used as search parameter: GET /DocumentReference?encounter=Encounter/{id}</td></tr></table><hr/><p><b>Group 2 </b>Mapping from <code>https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2</code> to <a href=\"http://hl7.org/fhir/R4/documentreference.html\">DocumentReference</a></p><table class=\"grid\"><tr><td><b>Source Code</b></td><td><b>Relationship</b></td><td><b>Target Code</b></td><td><b>Comment</b></td></tr><tr><td>careDocumentation.careDocumentationHeader.documentId (Document ID (unique business identifier))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>identifier</td><td>Unique document identifier within source system. Must be persistent across TKB versions. System derived from sourceSystemHSAid.</td></tr><tr><td>careDocumentation.careDocumentationHeader.patientId (Patient ID (personnummer/samordningsnummer/reservnummer))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>subject</td><td>Reference to Patient with Swedish national identifier. OID 1.2.752.129.2.1.3.1 (personnummer), 1.2.752.129.2.1.3.3 (samordningsnummer)</td></tr><tr><td>careDocumentation.careDocumentationHeader.approvedForPatient (Approved for patient access (true/false))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>meta.security</td><td>If false, add security label NOPATIENT to restrict patient access (menprövningsflagga). See tkb-header-mapping documentation.</td></tr><tr><td>careDocumentation.careDocumentationBody.documentType (Document type code (vårdkontaktanteckning, läkarintyg, etc.))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>type</td><td>Swedish document type. Use LOINC document codes or Swedish national codes. Examples: 11506-3 (progress note), 18842-5 (discharge summary), 57133-1 (referral note)</td></tr><tr><td>careDocumentation.careDocumentationBody.documentCategory (Document category (high-level classification))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>category</td><td>High-level category. Use US Core categories: clinical-note, summary-of-episode-note, discharge-summary, etc.</td></tr><tr><td>careDocumentation.careDocumentationBody.documentStatus (Document status (preliminary, final, amended, entered-in-error))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#relatedto\" title=\"relatedto\">is related to</a></td><td>status</td><td>Maps to DocumentReference.status (current|superseded|entered-in-error) and docStatus (preliminary|final|amended|corrected|appended)</td></tr><tr><td>careDocumentation.careDocumentationBody.documentTitle (Document title/description)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>description</td><td>Human-readable title. Also used in Composition.title.</td></tr><tr><td>careDocumentation.careDocumentationHeader.documentTime (Document creation timestamp)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>date</td><td>When document was created/indexed. Note: TKB may use authorTime instead for some documents.</td></tr><tr><td>careDocumentation.careDocumentationHeader.careContactId (Care contact ID (encounter context))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>context.encounter</td><td>Reference to Encounter resource. Links document to care contact.</td></tr><tr><td>careDocumentation.careDocumentationBody.content (Document content (binary or referenced))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>content.attachment</td><td>For unstructured content (PDF, XHTML, XML): use attachment.data (base64) or attachment.url. Set contentType (application/pdf, text/html, etc.)</td></tr><tr><td>careDocumentation.careDocumentationBody.format (Document format code)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>content.format</td><td>Format code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem or Swedish format codes</td></tr><tr><td>careDocumentation.careDocumentationBody.mimeType (MIME type (application/pdf, text/html, etc.))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>content.attachment.contentType</td><td>MIME type: application/pdf, text/html, application/fhir+xml, application/fhir+json, etc.</td></tr><tr><td>careDocumentation.careDocumentationHeader.nullified (Document nullified flag)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>status</td><td>If nullified=true, set status=entered-in-error. Use Provenance resource to capture nullifiedReason.</td></tr><tr><td>careDocumentation.careDocumentationHeader.nullifiedReason (Reason for nullification)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>Provenance.reason</td><td>Reason for nullification/retraction. Map to Provenance resource with activity=DELETE or UPDATE, reason containing the nullification reason text.</td></tr></table><hr/><p><b>Group 3 </b>Mapping from <code>https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2</code> to <a href=\"http://hl7.org/fhir/R4/composition.html\">Composition</a></p><table class=\"grid\"><tr><td><b>Source Code</b></td><td><b>Relationship</b></td><td><b>Target Code</b></td><td><b>Comment</b></td></tr><tr><td>careDocumentation.careDocumentationHeader.documentId (Document ID)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>identifier</td><td>Same identifier as DocumentReference for linking</td></tr><tr><td>careDocumentation.careDocumentationBody.documentStatus (Composition status)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#relatedto\" title=\"relatedto\">is related to</a></td><td>status</td><td>Composition.status: preliminary|final|amended|entered-in-error. Maps from TKB documentStatus.</td></tr><tr><td>careDocumentation.careDocumentationBody.documentType (Composition type)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>type</td><td>Same type code as DocumentReference.type. LOINC or Swedish document type codes.</td></tr><tr><td>careDocumentation.careDocumentationBody.documentCategory (Composition category)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>category</td><td>High-level categorization matching DocumentReference.category</td></tr><tr><td>careDocumentation.careDocumentationHeader.patientId (Patient ID)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>subject</td><td>Reference to Patient resource</td></tr><tr><td>careDocumentation.careDocumentationHeader.careContactId (Care contact/encounter context)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>encounter</td><td>Reference to Encounter when document created during care contact</td></tr><tr><td>careDocumentation.careDocumentationHeader.documentTime (Composition date)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>date</td><td>Composition edit/change time. May differ from authorTime.</td></tr><tr><td>careDocumentation.careDocumentationHeader.accountableHealthcareProfessional (Document author (healthcare professional))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>author</td><td>Reference to Practitioner. Can have multiple authors. Also mapped to Provenance for full metadata.</td></tr><tr><td>careDocumentation.careDocumentationBody.documentTitle (Composition title)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>title</td><td>Human-readable document title</td></tr><tr><td>careDocumentation.careDocumentationHeader.legalAuthenticator (Legal authenticator (attester))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>attester</td><td>Composition.attester with mode=#legal, time=signatureTime, party=Reference(Practitioner). Also creates Provenance.signature.</td></tr><tr><td>careDocumentation.careDocumentationBody.custodian (Document custodian (care provider organization))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>custodian</td><td>Reference to Organization (vårdgivare) responsible for document</td></tr><tr><td>careDocumentation.careDocumentationBody.section (Document sections (reason for visit, assessment, plan, etc.))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>section</td><td>Composition.section with code, title, text (narrative), and entry (references to resources). Common LOINC section codes: 10154-3 (chief complaint), 10164-2 (history), 29545-1 (physical exam), 51847-2 (assessment), 18776-5 (plan)</td></tr></table><hr/><p><b>Group 4 </b>Mapping from <code>https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2</code> to <a href=\"http://hl7.org/fhir/R4/provenance.html\">Provenance</a></p><table class=\"grid\"><tr><td><b>Source Code</b></td><td><b>Relationship</b></td><td><b>Target Code</b></td><td><b>Comment</b></td></tr><tr><td>careDocumentation.careDocumentationHeader.sourceSystemHSAid (Source system HSA-ID)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>entity.what</td><td>HSA-ID of source system. Also mapped to DocumentReference.meta.source as https://hsaid.se/{HSA-ID}. Provenance.entity.role=source.</td></tr><tr><td>careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.authorTime (Author time (registration timestamp))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>recorded</td><td>When document information was recorded. Also mapped to DocumentReference.meta.lastUpdated.</td></tr><tr><td>careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalHSAid (Healthcare professional HSA-ID)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>agent.who</td><td>Reference to Practitioner with HSA-ID. Provenance.agent.type=author. Also in Composition.author and DocumentReference.author.</td></tr><tr><td>careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalName (Healthcare professional name)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>agent.who.display</td><td>Display name. Full Practitioner resource should have structured name.</td></tr><tr><td>careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalRoleCode (Healthcare professional role/befattning)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#relatedto\" title=\"relatedto\">is related to</a></td><td>agent.role</td><td>Professional role (befattning). Use KV Befattning (OID 1.2.752.129.2.2.1.4). Map to Provenance.agent.role or store in Practitioner.qualification.</td></tr><tr><td>careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalOrgUnit (Organization unit (where professional works))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>agent.onBehalfOf</td><td>Reference to Organization (organizational unit). Full details (HSA-ID, name, telecom, address, location) in Organization resource.</td></tr><tr><td>careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalCareUnitHSAid (Care unit HSA-ID (vårdenhet))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>entity.what</td><td>HSA-ID for care unit. Reference to Organization. Part of PDL hierarchy. Also in DocumentReference.custodian.</td></tr><tr><td>careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalCareGiverHSAid (Care provider HSA-ID (vårdgivare))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>entity.what</td><td>HSA-ID for care provider. Top-level organization in PDL hierarchy. Reference to Organization.</td></tr><tr><td>careDocumentation.careDocumentationHeader.legalAuthenticator.signatureTime (Signature timestamp)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>signature.when</td><td>When document was digitally signed. Also in Composition.attester.time.</td></tr><tr><td>careDocumentation.careDocumentationHeader.legalAuthenticator.legalAuthenticatorHSAid (Legal authenticator HSA-ID)</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>signature.who</td><td>Reference to Practitioner who signed document. Provenance.agent.type=legal.</td></tr><tr><td>careDocumentation.careDocumentationHeader.legalAuthenticator.signatureData (Digital signature (cryptographic))</td><td><a href=\"http://hl7.org/fhir/R5/codesystem-concept-map-relationship.html#equivalent\" title=\"equivalent\">is equivalent to</a></td><td>signature.data</td><td>Base64 encoded signature. Set sigFormat (application/jose, application/xmldsig+xml, etc.). Type code: 1.2.840.10065.1.12.1.1 (Author's Signature)</td></tr></table><hr/><p><b>Group 5 </b>Mapping from <code>https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2</code> to <a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></p><table class=\"grid\"><tr><td><b>Source Code</b></td><td><b>Relationship</b></td><td><b>Target Code</b></td><td><b>Comment</b></td></tr><tr><td>result.resultCode (Result code (OK, INFO, ERROR))</td><td colspan=\"2\" style=\"background-color: #efefef\">(not mapped)</td><td style=\"background-color: #efefef\">NOT MAPPED to resources. HTTP status: OK→200, INFO→200 with warnings, ERROR→4xx/5xx. Bundle-level OperationOutcome for details.</td></tr><tr><td>result.errorCode (Error code)</td><td colspan=\"2\" style=\"background-color: #efefef\">(not mapped)</td><td style=\"background-color: #efefef\">NOT MAPPED to resources. Use in OperationOutcome.issue.code when resultCode=ERROR.</td></tr><tr><td>result.logId (Log ID (UUID for troubleshooting))</td><td colspan=\"2\" style=\"background-color: #efefef\">(not mapped)</td><td style=\"background-color: #efefef\">NOT MAPPED to resources. Use in OperationOutcome.issue.diagnostics or X-Request-Id header.</td></tr><tr><td>result.message (Result message)</td><td colspan=\"2\" style=\"background-color: #efefef\">(not mapped)</td><td style=\"background-color: #efefef\">NOT MAPPED to resources. User-facing message in OperationOutcome.issue.diagnostics.</td></tr></table></div>"^^rdf:XMLLiteral ] ] ; # fhir:url [ fhir:v "https://inera.se/fhir/core/ConceptMap/getcaredocumentation-tkb-to-documentreference"^^xsd:anyURI ; fhir:l <https://inera.se/fhir/core/ConceptMap/getcaredocumentation-tkb-to-documentreference> ] ; # fhir:version [ fhir:v "0.2.0"] ; # fhir:name [ fhir:v "ConceptMapGetCareDocumentationTKBToDocumentReference"] ; # fhir:title [ fhir:v "ConceptMap GetCareDocumentation TKB to FHIR DocumentReference/Composition"] ; # fhir:status [ fhir:v "draft"] ; # fhir:experimental [ fhir:v true] ; # fhir:date [ fhir:v "2025-11-24"^^xsd:date] ; # fhir:publisher [ fhir:v "Inera AB"] ; # fhir:contact ( [ fhir:name [ fhir:v "Inera AB" ] ; ( fhir:telecom [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "https://www.inera.se" ] ] [ fhir:system [ fhir:v "email" ] ; fhir:value [ fhir:v "info@inera.se" ] ] ) ] [ fhir:name [ fhir:v "Inera AB" ] ; ( fhir:telecom [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "https://www.inera.se" ] ] [ fhir:system [ fhir:v "email" ] ; fhir:value [ fhir:v "info@inera.se" ] ] ) ] ) ; # fhir:description [ fhir:v "Complete mapping from GetCareDocumentation TKB service to FHIR DocumentReference, Composition, and Provenance resources"] ; # fhir:jurisdiction ( [ ( fhir:coding [ fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ; fhir:l <urn:iso:std:iso:3166> ] ; fhir:code [ fhir:v "SE" ] ; fhir:display [ fhir:v "Sweden" ] ] ) ] ) ; # fhir:source [ a fhir:Uri ; fhir:v "https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2"^^xsd:anyURI ; fhir:l <https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2> ] ; # fhir:target [ a fhir:Canonical ; fhir:v "http://hl7.org/fhir/StructureDefinition/DocumentReference"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/DocumentReference> ] ; # fhir:group ( [ fhir:source [ fhir:v "https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2"^^xsd:anyURI ; fhir:l <https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2> ] ; fhir:target [ fhir:v "http://hl7.org/fhir/StructureDefinition/Bundle"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/Bundle> ] ; ( fhir:element [ fhir:code [ fhir:v "patientId" ] ; fhir:display [ fhir:v "Query parameter: Patient ID filter" ] ; ( fhir:target [ fhir:equivalence [ fhir:v "unmatched" ] ; fhir:comment [ fhir:v "NOT MAPPED. Used as search parameter: GET /DocumentReference?subject=Patient/191212121212" ] ] ) ] [ fhir:code [ fhir:v "careUnitHSAid" ] ; fhir:display [ fhir:v "Query parameter: Filter by care unit HSA-ID" ] ; ( fhir:target [ fhir:equivalence [ fhir:v "unmatched" ] ; fhir:comment [ fhir:v "NOT MAPPED. Used as search parameter: GET /DocumentReference?custodian.identifier=https://hsaid.se|SE2321000016-A001" ] ] ) ] [ fhir:code [ fhir:v "sourceSystemHSAid" ] ; fhir:display [ fhir:v "Query parameter: Filter by source system" ] ; ( fhir:target [ fhir:equivalence [ fhir:v "unmatched" ] ; fhir:comment [ fhir:v "NOT MAPPED. Used as search parameter or routing to specific system" ] ] ) ] [ fhir:code [ fhir:v "timePeriod" ] ; fhir:display [ fhir:v "Query parameter: Time period filter (from-to)" ] ; ( fhir:target [ fhir:equivalence [ fhir:v "unmatched" ] ; fhir:comment [ fhir:v "NOT MAPPED. Used as search parameter: GET /DocumentReference?date=ge2025-01-01&date=le2025-12-31" ] ] ) ] [ fhir:code [ fhir:v "careContactId" ] ; fhir:display [ fhir:v "Query parameter: Filter by specific care contact" ] ; ( fhir:target [ fhir:equivalence [ fhir:v "unmatched" ] ; fhir:comment [ fhir:v "NOT MAPPED. Used as search parameter: GET /DocumentReference?encounter=Encounter/{id}" ] ] ) ] ) ] [ fhir:source [ fhir:v "https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2"^^xsd:anyURI ; fhir:l <https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2> ] ; fhir:target [ fhir:v "http://hl7.org/fhir/StructureDefinition/DocumentReference"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/DocumentReference> ] ; ( fhir:element [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.documentId" ] ; fhir:display [ fhir:v "Document ID (unique business identifier)" ] ; ( fhir:target [ fhir:code [ fhir:v "identifier" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Unique document identifier within source system. Must be persistent across TKB versions. System derived from sourceSystemHSAid." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.patientId" ] ; fhir:display [ fhir:v "Patient ID (personnummer/samordningsnummer/reservnummer)" ] ; ( fhir:target [ fhir:code [ fhir:v "subject" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Reference to Patient with Swedish national identifier. OID 1.2.752.129.2.1.3.1 (personnummer), 1.2.752.129.2.1.3.3 (samordningsnummer)" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.approvedForPatient" ] ; fhir:display [ fhir:v "Approved for patient access (true/false)" ] ; ( fhir:target [ fhir:code [ fhir:v "meta.security" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "If false, add security label NOPATIENT to restrict patient access (menprövningsflagga). See tkb-header-mapping documentation." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.documentType" ] ; fhir:display [ fhir:v "Document type code (vårdkontaktanteckning, läkarintyg, etc.)" ] ; ( fhir:target [ fhir:code [ fhir:v "type" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Swedish document type. Use LOINC document codes or Swedish national codes. Examples: 11506-3 (progress note), 18842-5 (discharge summary), 57133-1 (referral note)" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.documentCategory" ] ; fhir:display [ fhir:v "Document category (high-level classification)" ] ; ( fhir:target [ fhir:code [ fhir:v "category" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "High-level category. Use US Core categories: clinical-note, summary-of-episode-note, discharge-summary, etc." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.documentStatus" ] ; fhir:display [ fhir:v "Document status (preliminary, final, amended, entered-in-error)" ] ; ( fhir:target [ fhir:code [ fhir:v "status" ] ; fhir:equivalence [ fhir:v "relatedto" ] ; fhir:comment [ fhir:v "Maps to DocumentReference.status (current|superseded|entered-in-error) and docStatus (preliminary|final|amended|corrected|appended)" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.documentTitle" ] ; fhir:display [ fhir:v "Document title/description" ] ; ( fhir:target [ fhir:code [ fhir:v "description" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Human-readable title. Also used in Composition.title." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.documentTime" ] ; fhir:display [ fhir:v "Document creation timestamp" ] ; ( fhir:target [ fhir:code [ fhir:v "date" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "When document was created/indexed. Note: TKB may use authorTime instead for some documents." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.careContactId" ] ; fhir:display [ fhir:v "Care contact ID (encounter context)" ] ; ( fhir:target [ fhir:code [ fhir:v "context.encounter" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Reference to Encounter resource. Links document to care contact." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.content" ] ; fhir:display [ fhir:v "Document content (binary or referenced)" ] ; ( fhir:target [ fhir:code [ fhir:v "content.attachment" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "For unstructured content (PDF, XHTML, XML): use attachment.data (base64) or attachment.url. Set contentType (application/pdf, text/html, etc.)" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.format" ] ; fhir:display [ fhir:v "Document format code" ] ; ( fhir:target [ fhir:code [ fhir:v "content.format" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Format code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem or Swedish format codes" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.mimeType" ] ; fhir:display [ fhir:v "MIME type (application/pdf, text/html, etc.)" ] ; ( fhir:target [ fhir:code [ fhir:v "content.attachment.contentType" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "MIME type: application/pdf, text/html, application/fhir+xml, application/fhir+json, etc." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.nullified" ] ; fhir:display [ fhir:v "Document nullified flag" ] ; ( fhir:target [ fhir:code [ fhir:v "status" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "If nullified=true, set status=entered-in-error. Use Provenance resource to capture nullifiedReason." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.nullifiedReason" ] ; fhir:display [ fhir:v "Reason for nullification" ] ; ( fhir:target [ fhir:code [ fhir:v "Provenance.reason" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Reason for nullification/retraction. Map to Provenance resource with activity=DELETE or UPDATE, reason containing the nullification reason text." ] ] ) ] ) ] [ fhir:source [ fhir:v "https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2"^^xsd:anyURI ; fhir:l <https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2> ] ; fhir:target [ fhir:v "http://hl7.org/fhir/StructureDefinition/Composition"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/Composition> ] ; ( fhir:element [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.documentId" ] ; fhir:display [ fhir:v "Document ID" ] ; ( fhir:target [ fhir:code [ fhir:v "identifier" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Same identifier as DocumentReference for linking" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.documentStatus" ] ; fhir:display [ fhir:v "Composition status" ] ; ( fhir:target [ fhir:code [ fhir:v "status" ] ; fhir:equivalence [ fhir:v "relatedto" ] ; fhir:comment [ fhir:v "Composition.status: preliminary|final|amended|entered-in-error. Maps from TKB documentStatus." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.documentType" ] ; fhir:display [ fhir:v "Composition type" ] ; ( fhir:target [ fhir:code [ fhir:v "type" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Same type code as DocumentReference.type. LOINC or Swedish document type codes." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.documentCategory" ] ; fhir:display [ fhir:v "Composition category" ] ; ( fhir:target [ fhir:code [ fhir:v "category" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "High-level categorization matching DocumentReference.category" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.patientId" ] ; fhir:display [ fhir:v "Patient ID" ] ; ( fhir:target [ fhir:code [ fhir:v "subject" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Reference to Patient resource" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.careContactId" ] ; fhir:display [ fhir:v "Care contact/encounter context" ] ; ( fhir:target [ fhir:code [ fhir:v "encounter" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Reference to Encounter when document created during care contact" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.documentTime" ] ; fhir:display [ fhir:v "Composition date" ] ; ( fhir:target [ fhir:code [ fhir:v "date" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Composition edit/change time. May differ from authorTime." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.accountableHealthcareProfessional" ] ; fhir:display [ fhir:v "Document author (healthcare professional)" ] ; ( fhir:target [ fhir:code [ fhir:v "author" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Reference to Practitioner. Can have multiple authors. Also mapped to Provenance for full metadata." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.documentTitle" ] ; fhir:display [ fhir:v "Composition title" ] ; ( fhir:target [ fhir:code [ fhir:v "title" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Human-readable document title" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.legalAuthenticator" ] ; fhir:display [ fhir:v "Legal authenticator (attester)" ] ; ( fhir:target [ fhir:code [ fhir:v "attester" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Composition.attester with mode=#legal, time=signatureTime, party=Reference(Practitioner). Also creates Provenance.signature." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.custodian" ] ; fhir:display [ fhir:v "Document custodian (care provider organization)" ] ; ( fhir:target [ fhir:code [ fhir:v "custodian" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Reference to Organization (vårdgivare) responsible for document" ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationBody.section" ] ; fhir:display [ fhir:v "Document sections (reason for visit, assessment, plan, etc.)" ] ; ( fhir:target [ fhir:code [ fhir:v "section" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Composition.section with code, title, text (narrative), and entry (references to resources). Common LOINC section codes: 10154-3 (chief complaint), 10164-2 (history), 29545-1 (physical exam), 51847-2 (assessment), 18776-5 (plan)" ] ] ) ] ) ] [ fhir:source [ fhir:v "https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2"^^xsd:anyURI ; fhir:l <https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2> ] ; fhir:target [ fhir:v "http://hl7.org/fhir/StructureDefinition/Provenance"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/Provenance> ] ; ( fhir:element [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.sourceSystemHSAid" ] ; fhir:display [ fhir:v "Source system HSA-ID" ] ; ( fhir:target [ fhir:code [ fhir:v "entity.what" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "HSA-ID of source system. Also mapped to DocumentReference.meta.source as https://hsaid.se/{HSA-ID}. Provenance.entity.role=source." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.authorTime" ] ; fhir:display [ fhir:v "Author time (registration timestamp)" ] ; ( fhir:target [ fhir:code [ fhir:v "recorded" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "When document information was recorded. Also mapped to DocumentReference.meta.lastUpdated." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalHSAid" ] ; fhir:display [ fhir:v "Healthcare professional HSA-ID" ] ; ( fhir:target [ fhir:code [ fhir:v "agent.who" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Reference to Practitioner with HSA-ID. Provenance.agent.type=author. Also in Composition.author and DocumentReference.author." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalName" ] ; fhir:display [ fhir:v "Healthcare professional name" ] ; ( fhir:target [ fhir:code [ fhir:v "agent.who.display" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Display name. Full Practitioner resource should have structured name." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalRoleCode" ] ; fhir:display [ fhir:v "Healthcare professional role/befattning" ] ; ( fhir:target [ fhir:code [ fhir:v "agent.role" ] ; fhir:equivalence [ fhir:v "relatedto" ] ; fhir:comment [ fhir:v "Professional role (befattning). Use KV Befattning (OID 1.2.752.129.2.2.1.4). Map to Provenance.agent.role or store in Practitioner.qualification." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalOrgUnit" ] ; fhir:display [ fhir:v "Organization unit (where professional works)" ] ; ( fhir:target [ fhir:code [ fhir:v "agent.onBehalfOf" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Reference to Organization (organizational unit). Full details (HSA-ID, name, telecom, address, location) in Organization resource." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalCareUnitHSAid" ] ; fhir:display [ fhir:v "Care unit HSA-ID (vårdenhet)" ] ; ( fhir:target [ fhir:code [ fhir:v "entity.what" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "HSA-ID for care unit. Reference to Organization. Part of PDL hierarchy. Also in DocumentReference.custodian." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.accountableHealthcareProfessional.healthcareProfessionalCareGiverHSAid" ] ; fhir:display [ fhir:v "Care provider HSA-ID (vårdgivare)" ] ; ( fhir:target [ fhir:code [ fhir:v "entity.what" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "HSA-ID for care provider. Top-level organization in PDL hierarchy. Reference to Organization." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.legalAuthenticator.signatureTime" ] ; fhir:display [ fhir:v "Signature timestamp" ] ; ( fhir:target [ fhir:code [ fhir:v "signature.when" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "When document was digitally signed. Also in Composition.attester.time." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.legalAuthenticator.legalAuthenticatorHSAid" ] ; fhir:display [ fhir:v "Legal authenticator HSA-ID" ] ; ( fhir:target [ fhir:code [ fhir:v "signature.who" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Reference to Practitioner who signed document. Provenance.agent.type=legal." ] ] ) ] [ fhir:code [ fhir:v "careDocumentation.careDocumentationHeader.legalAuthenticator.signatureData" ] ; fhir:display [ fhir:v "Digital signature (cryptographic)" ] ; ( fhir:target [ fhir:code [ fhir:v "signature.data" ] ; fhir:equivalence [ fhir:v "equivalent" ] ; fhir:comment [ fhir:v "Base64 encoded signature. Set sigFormat (application/jose, application/xmldsig+xml, etc.). Type code: 1.2.840.10065.1.12.1.1 (Author's Signature)" ] ] ) ] ) ] [ fhir:source [ fhir:v "https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2"^^xsd:anyURI ; fhir:l <https://rivta.se/domains/clinicalprocess/healthcond/description/GetCareDocumentationResponder/2> ] ; fhir:target [ fhir:v "http://hl7.org/fhir/StructureDefinition/Bundle"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/Bundle> ] ; ( fhir:element [ fhir:code [ fhir:v "result.resultCode" ] ; fhir:display [ fhir:v "Result code (OK, INFO, ERROR)" ] ; ( fhir:target [ fhir:equivalence [ fhir:v "unmatched" ] ; fhir:comment [ fhir:v "NOT MAPPED to resources. HTTP status: OK→200, INFO→200 with warnings, ERROR→4xx/5xx. Bundle-level OperationOutcome for details." ] ] ) ] [ fhir:code [ fhir:v "result.errorCode" ] ; fhir:display [ fhir:v "Error code" ] ; ( fhir:target [ fhir:equivalence [ fhir:v "unmatched" ] ; fhir:comment [ fhir:v "NOT MAPPED to resources. Use in OperationOutcome.issue.code when resultCode=ERROR." ] ] ) ] [ fhir:code [ fhir:v "result.logId" ] ; fhir:display [ fhir:v "Log ID (UUID for troubleshooting)" ] ; ( fhir:target [ fhir:equivalence [ fhir:v "unmatched" ] ; fhir:comment [ fhir:v "NOT MAPPED to resources. Use in OperationOutcome.issue.diagnostics or X-Request-Id header." ] ] ) ] [ fhir:code [ fhir:v "result.message" ] ; fhir:display [ fhir:v "Result message" ] ; ( fhir:target [ fhir:equivalence [ fhir:v "unmatched" ] ; fhir:comment [ fhir:v "NOT MAPPED to resources. User-facing message in OperationOutcome.issue.diagnostics." ] ] ) ] ) ] ) . #
IG © 2025+ Inera AB. Package se.inera.core#0.2.0 based on FHIR 4.0.1. Generated 2025-12-16
Links: Table of Contents |
QA Report