MCC eCare Plan Draft Implementation Guide
0.1.0 - CI Build
MCC eCare Plan Draft Implementation Guide
0.1.0 - CI Build
MCC eCare Plan Draft Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Defining URL: | http://hl7.org/fhir/us/mcc/StructureDefinition/BoneSurveyXrays |
| Version: | 0.1.0 |
| Name: | BoneSurveyXrays |
| Title: | Bone Survey Xrays |
| Status: | Active as of 2020-11-02T17:51:13+00:00 |
| Definition: | This profile constrains US Core Diagnostic Report Note to Diagnostic Reports about bone survey xrays. |
| Publisher: | HL7 International - Patient Care WG |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/mcc/StructureDefinition/BoneSurveyXrays
This US Core Diagnostic Report Profile sets minimum expectations for searching and fetching Diagnostic Reports and Notes using the DiagnosticReport resource. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the DiagnosticReport when using the profile.
In addition to the requirements set in the US Core Diagnostic Report Profile, this profile sets additional expectations to focus on searching and fetching reports about bone survey xrays. DiagnosticReport.code is bound to a bone survey xray value set.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreDiagnosticReportProfileNoteExchange
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 | |
  extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:resource-pertainsToGoal | S | 0..* | Extension | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. Fixed Value: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
 basedOn | S | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested |
 code | 1..1 | CodeableConcept | Bone Survey Xray Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.156/expansion (required) | |
| 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 | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:resource-pertainsToGoal | S | 0..* | Extension | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. Fixed Value: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business identifier for report |
 basedOn | S | 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 | Bone Survey Xray Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.156/expansion (required) |
| 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 | Time of the report or note | |
 effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| issued | SΣ | 0..1 | instant | DateTime this version was made |
| performer | SΣ | 0..* | Reference(US Core Practitioner Profile | US Core 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 | Σ | 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) | |
| presentedForm | S | 0..* | Attachment | Entire report as issued |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | 0..* | USCoreDiagnosticReportProfileNoteExchange | US Core Diagnostic Report Profile for Report and Note exchange | |
| extension:resource-pertainsToGoal | 0..* | Extension | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. Fixed Value: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | |
| basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |
| status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
| category | Σ | 1..* | CodeableConcept | Service category Binding: US Core DiagnosticReport Category (extensible) |
| code | Σ | 1..1 | CodeableConcept | Bone Survey Xray Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.156/expansion (required) |
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | The subject of the report - usually, but not always, the patient |
| encounter | Σ | 0..1 | Reference(US Core Encounter Profile) | Health care event when test ordered |
| effective[x] | Σ | 1..1 | Time of the report or note | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| issued | Σ | 0..1 | instant | DateTime this version was made |
| performer | Σ | 0..* | Reference(US Core Practitioner Profile | US Core Organization Profile) | Responsible Diagnostic Service |
| presentedForm | 0..* | Attachment | Entire report as issued | |
| Documentation for this format | ||||
This structure is derived from USCoreDiagnosticReportProfileNoteExchange
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 | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:resource-pertainsToGoal | S | 0..* | Extension | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. Fixed Value: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
| basedOn | S | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested |
| code | 1..1 | CodeableConcept | Bone Survey Xray Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.156/expansion (required) | |
| 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 | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:resource-pertainsToGoal | S | 0..* | Extension | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. Fixed Value: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business identifier for report |
| basedOn | S | 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 | Bone Survey Xray Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.156/expansion (required) |
| 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 | Time of the report or note | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| issued | SΣ | 0..1 | instant | DateTime this version was made |
| performer | SΣ | 0..* | Reference(US Core Practitioner Profile | US Core 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 | Σ | 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) | |
| presentedForm | S | 0..* | Attachment | Entire report as issued |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| DiagnosticReport.language | preferred | CommonLanguages Max Binding: AllLanguages |
| DiagnosticReport.status | required | DiagnosticReportStatus |
| DiagnosticReport.category | extensible | USCoreDiagnosticReportCategory |
| DiagnosticReport.code | required | https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.156/expansion |
| 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.extension:resource-pertainsToGoal | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DiagnosticReport.extension:resource-pertainsToGoal | 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 - Patient Care WG. Package hl7.fhir.us.mcc#0.1.0 based on FHIR 4.0.1. Generated 2020-11-02
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change