Canadian Core
0.1.0 - CI Build

Canadian Core, published by Canadian FHIR Implementor Working Group. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/scratch-fhir-profiles/CA-Core/ and changes regularly. See the Directory of published versions

Resource Profile: Diagnostic Report for Report and Note Exchange Profile

Defining URL:http://hl7.org/fhir/ca/core/StructureDefinition/profile-diagnosticreportnote
Version:0.1.0
Name:DiagnosticReportNoteProfile
Title:Diagnostic Report for Report and Note Exchange Profile
Status:Draft as of 2020-11-25T22:40:51+00:00
Definition:

Proposed constraints and extensions on the Diagnostic Report Resource to support collection of diagnostic report information for reports and notes. Generated as a first step toward creating a set of Canadian Core FHIR profiles.

Publisher:Canadian FHIR Implementor Working Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/ca/core/StructureDefinition/profile-diagnosticreportnote

Formal Views of Profile Content

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

This structure is derived from DiagnosticReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..*DiagnosticReportDiagnosticReport for Report and Note Profile
... status S1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): Codes providing the status of a DiagnosticReport.

... category S1..*CodeableConceptCA Core Category Code
Binding: http://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-category (extensible): The CA Core Diagnostic Report Cateogy Value Set is a 'starter set' of categories supported for fetching and Diagnostic Reports and Notes.

... code S1..1CodeableConceptCA Core Report Code
Binding: http://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-report-and-note-codes (extensible): CA Core Diagnostic Report and Note Codes

... encounter S0..1Reference(Encounter Profile)Health care event when test ordered
... effective[x] S1..1dateTime, PeriodTime of report or note
... issued S0..1instantDate/Time this version of the DiagnosticReport was made available
... performer S0..*Reference(Practitioner Profile (General)), Reference(Organization Profile)Responsible Diagnostic Service
... media S0..*BackboneElementKey images associated with this report
... presentedForm S0..*AttachmentEntire report as issued

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..*DiagnosticReportDiagnosticReport for Report and Note Profile
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for report
... basedOn 0..*Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)What was requested
... status ?!SΣ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): Codes providing the status of a DiagnosticReport.

... category SΣ1..*CodeableConceptCA Core Category Code
Binding: http://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-category (extensible): The CA Core Diagnostic Report Cateogy Value Set is a 'starter set' of categories supported for fetching and Diagnostic Reports and Notes.


... code SΣ1..1CodeableConceptCA Core Report Code
Binding: http://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-report-and-note-codes (extensible): CA Core Diagnostic Report and Note Codes

... subject SΣ1..1Reference(Patient Profile)The patient that the diagnostic report refers to
... encounter SΣ0..1Reference(Encounter Profile)Health care event when test ordered
... effective[x] SΣ1..1Time of report or note
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued SΣ0..1instantDate/Time this version of the DiagnosticReport was made available
... performer SΣ0..*Reference(Practitioner Profile (General)), Reference(Organization Profile)Responsible Diagnostic Service
... resultsInterpreter Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result 0..*Reference(Observation)Observations
... imagingStudy 0..*Reference(ImagingStudy)Reference to full details of imaging associated with the diagnostic report
... media SΣ0..*BackboneElementKey images associated with this report
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(Media)Reference to the image source
... conclusion 0..1stringClinical conclusion (interpretation) of test results
... conclusionCode 0..*CodeableConceptCodes for the clinical conclusion of test results
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.


... presentedForm S0..*AttachmentEntire report as issued

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..*DiagnosticReportDiagnosticReport for Report and Note Profile
... status ?!Σ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): Codes providing the status of a DiagnosticReport.

... category Σ1..*CodeableConceptCA Core Category Code
Binding: http://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-category (extensible): The CA Core Diagnostic Report Cateogy Value Set is a 'starter set' of categories supported for fetching and Diagnostic Reports and Notes.


... code Σ1..1CodeableConceptCA Core Report Code
Binding: http://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-report-and-note-codes (extensible): CA Core Diagnostic Report and Note Codes

... encounter Σ0..1Reference(Encounter Profile)Health care event when test ordered
... effective[x] Σ1..1Time of report or note
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version of the DiagnosticReport was made available
... performer Σ0..*Reference(Practitioner Profile (General)), Reference(Organization Profile)Responsible Diagnostic Service
... media Σ0..*BackboneElementKey images associated with this report
... presentedForm 0..*AttachmentEntire report as issued

doco Documentation for this format

Differential View

This structure is derived from DiagnosticReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..*DiagnosticReportDiagnosticReport for Report and Note Profile
... status S1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): Codes providing the status of a DiagnosticReport.

... category S1..*CodeableConceptCA Core Category Code
Binding: http://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-category (extensible): The CA Core Diagnostic Report Cateogy Value Set is a 'starter set' of categories supported for fetching and Diagnostic Reports and Notes.

... code S1..1CodeableConceptCA Core Report Code
Binding: http://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-report-and-note-codes (extensible): CA Core Diagnostic Report and Note Codes

... encounter S0..1Reference(Encounter Profile)Health care event when test ordered
... effective[x] S1..1dateTime, PeriodTime of report or note
... issued S0..1instantDate/Time this version of the DiagnosticReport was made available
... performer S0..*Reference(Practitioner Profile (General)), Reference(Organization Profile)Responsible Diagnostic Service
... media S0..*BackboneElementKey images associated with this report
... presentedForm S0..*AttachmentEntire report as issued

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..*DiagnosticReportDiagnosticReport for Report and Note Profile
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for report
... basedOn 0..*Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)What was requested
... status ?!SΣ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): Codes providing the status of a DiagnosticReport.

... category SΣ1..*CodeableConceptCA Core Category Code
Binding: http://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-category (extensible): The CA Core Diagnostic Report Cateogy Value Set is a 'starter set' of categories supported for fetching and Diagnostic Reports and Notes.


... code SΣ1..1CodeableConceptCA Core Report Code
Binding: http://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-report-and-note-codes (extensible): CA Core Diagnostic Report and Note Codes

... subject SΣ1..1Reference(Patient Profile)The patient that the diagnostic report refers to
... encounter SΣ0..1Reference(Encounter Profile)Health care event when test ordered
... effective[x] SΣ1..1Time of report or note
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued SΣ0..1instantDate/Time this version of the DiagnosticReport was made available
... performer SΣ0..*Reference(Practitioner Profile (General)), Reference(Organization Profile)Responsible Diagnostic Service
... resultsInterpreter Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result 0..*Reference(Observation)Observations
... imagingStudy 0..*Reference(ImagingStudy)Reference to full details of imaging associated with the diagnostic report
... media SΣ0..*BackboneElementKey images associated with this report
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(Media)Reference to the image source
... conclusion 0..1stringClinical conclusion (interpretation) of test results
... conclusionCode 0..*CodeableConceptCodes for the clinical conclusion of test results
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.


... presentedForm S0..*AttachmentEntire report as issued

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
DiagnosticReport.languagepreferredCommonLanguages
Max Binding: AllLanguages
DiagnosticReport.statusrequiredDiagnosticReportStatus
DiagnosticReport.categoryextensiblehttp://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-category
DiagnosticReport.codeextensiblehttp://hl7.org/fhir/ca/core/ValueSet/ca-core-diagnosticreport-report-and-note-codes
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings

Constraints

IdPathDetailsRequirements
dom-2DiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3DiagnosticReportIf 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-4DiagnosticReportIf 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-5DiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6DiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1DiagnosticReport.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DiagnosticReport.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DiagnosticReport.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DiagnosticReport.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DiagnosticReport.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.effective[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.issuedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.resultsInterpreterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.specimenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.resultAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.imagingStudyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.mediaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.media.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DiagnosticReport.media.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DiagnosticReport.media.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1DiagnosticReport.media.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1DiagnosticReport.media.commentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.media.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.conclusionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.conclusionCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1DiagnosticReport.presentedFormAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())