Cancer Pathology Data Sharing
0.1.0 - STU 1 Ballot
Cancer Pathology Data Sharing
0.1.0 - STU 1 Ballot
This page is part of the Sharing eCC Data from Pathology Labs to EHR (v0.1.0: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/cancer-reporting/StructureDefinition/us-pathology-diagnostic-report |
| Version: | 0.1.0 |
| Name: | USPathologyDiagnosticReport |
| Title: | US Pathology Diagnostic Report |
| Status: | Active as of 2021-08-12T15:45:55+00:00 |
| Publisher: | HL7 International - Orders and Observations |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/cancer-reporting/StructureDefinition/us-pathology-diagnostic-report
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreDiagnosticReportProfileNoteExchange
Summary
Mandatory: 1 element
Must-Support: 4 elements
Structures
This structure refers to these other structures:
This structure is derived from USCoreDiagnosticReportProfileNoteExchange
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DiagnosticReport | 0..* | USCoreDiagnosticReportProfileNoteExchange | US Core Diagnostic Report Profile for Report and Note exchange | |
  subject | S | 1..1 | Reference(US Core Patient Profile) | The subject of the report - usually, but not always, the patient |
 performer | S | 0..* | Reference(US Core Practitioner Profile | US Core Organization Profile | US Pathology Related Practitioner Roles | US Core CareTeam Profile) | Responsible Diagnostic Service |
| resultsInterpreter | S | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
 specimen | S | 0..* | Reference(US Pathology Specimen) | Specimens this report is based on |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | 0..* | USCoreDiagnosticReportProfileNoteExchange | US Core Diagnostic Report Profile for Report and Note exchange | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business identifier for report |
| basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |
| status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
| category | SΣ | 1..* | CodeableConcept | Service category Binding: US Core DiagnosticReport Category (extensible) |
| code | SΣ | 1..1 | CodeableConcept | US Core Report Code Binding: US Core DiagnosticReport Report And Note Codes (extensible): LOINC codes |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | The subject of the report - usually, but not always, the patient |
| encounter | SΣ | 0..1 | Reference(US Core Encounter Profile) | Health care event when test ordered |
  effective[x] | SΣ | 1..1 | Clinically relevant time/time-period for report | |
 effectiveDateTime | dateTime S | |||
| effectivePeriod | Period | |||
| issued | SΣ | 0..1 | instant | DateTime this version was made |
| performer | SΣ | 0..* | Reference(US Core Practitioner Profile | US Core Organization Profile | US Pathology Related Practitioner Roles | US Core CareTeam Profile) | Responsible Diagnostic Service |
| resultsInterpreter | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
| specimen | S | 0..* | Reference(US Pathology 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 | Σ | 0..* | BackboneElement | Key images associated with this report |
| 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 |
| comment | 0..1 | string | Comment about the image (e.g. explanation) | |
| link | Σ | 1..1 | Reference(Media) | Reference to the image source |
| conclusion | 0..1 | string | Clinical conclusion (interpretation) of test results | |
| conclusionCode | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |
| presentedForm | S | 0..* | Attachment | Entire report as issued |
| Documentation for this format | ||||
This structure is derived from USCoreDiagnosticReportProfileNoteExchange
Summary
Mandatory: 1 element
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from USCoreDiagnosticReportProfileNoteExchange
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | 0..* | USCoreDiagnosticReportProfileNoteExchange | US Core Diagnostic Report Profile for Report and Note exchange | |
| subject | S | 1..1 | Reference(US Core Patient Profile) | The subject of the report - usually, but not always, the patient |
| performer | S | 0..* | Reference(US Core Practitioner Profile | US Core Organization Profile | US Pathology Related Practitioner Roles | US Core CareTeam Profile) | Responsible Diagnostic Service |
| resultsInterpreter | S | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
| specimen | S | 0..* | Reference(US Pathology Specimen) | Specimens this report is based on |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | 0..* | USCoreDiagnosticReportProfileNoteExchange | US Core Diagnostic Report Profile for Report and Note exchange | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business identifier for report |
| basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |
| status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
| category | SΣ | 1..* | CodeableConcept | Service category Binding: US Core DiagnosticReport Category (extensible) |
| code | SΣ | 1..1 | CodeableConcept | US Core Report Code Binding: US Core DiagnosticReport Report And Note Codes (extensible): LOINC codes |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | The subject of the report - usually, but not always, the patient |
| encounter | SΣ | 0..1 | Reference(US Core Encounter Profile) | Health care event when test ordered |
| effective[x] | SΣ | 1..1 | Clinically relevant time/time-period for report | |
| effectiveDateTime | dateTime S | |||
| effectivePeriod | Period | |||
| issued | SΣ | 0..1 | instant | DateTime this version was made |
| performer | SΣ | 0..* | Reference(US Core Practitioner Profile | US Core Organization Profile | US Pathology Related Practitioner Roles | US Core CareTeam Profile) | Responsible Diagnostic Service |
| resultsInterpreter | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
| specimen | S | 0..* | Reference(US Pathology 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 | Σ | 0..* | BackboneElement | Key images associated with this report |
| 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 |
| comment | 0..1 | string | Comment about the image (e.g. explanation) | |
| link | Σ | 1..1 | Reference(Media) | Reference to the image source |
| conclusion | 0..1 | string | Clinical conclusion (interpretation) of test results | |
| conclusionCode | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |
| presentedForm | S | 0..* | Attachment | Entire report as issued |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| DiagnosticReport.language | preferred | CommonLanguages Max Binding: AllLanguages |
| DiagnosticReport.status | required | DiagnosticReportStatus |
| DiagnosticReport.category | extensible | USCoreDiagnosticReportCategory |
| DiagnosticReport.code | extensible | USCoreDiagnosticReportReportAndNoteCodes |
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindings |
| Id | Path | Details | Requirements |
| dom-2 | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | DiagnosticReport | 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 | DiagnosticReport | 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 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | DiagnosticReport.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DiagnosticReport.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DiagnosticReport.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DiagnosticReport.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DiagnosticReport.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.effective[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.issued | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.resultsInterpreter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.specimen | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.result | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.imagingStudy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.media | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.media.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DiagnosticReport.media.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DiagnosticReport.media.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DiagnosticReport.media.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DiagnosticReport.media.comment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.media.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.conclusion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.conclusionCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DiagnosticReport.presentedForm | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Orders and Observations. Package hl7.fhir.us.cancer-reporting#0.1.0 based on FHIR 4.0.1. Generated 2021-08-12
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change