Physical Activity Implementation Guide
1.0.1 - STU Release 1
Physical Activity Implementation Guide
1.0.1 - STU Release 1
Physical Activity Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/physical-activity/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-diagnosticreport | Version: 1.0.1 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: PADiagnosticReport | ||
Conveys a summary of the interventions and patient interactions that have occurred over the course of the services delivered by a Service Provider, typically in response to a referral
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | |
  implicitRules | 0..0 | |||
 modifierExtension | 0..0 | |||
  Slices for basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested Slice: Unordered, Open by profile:resolve() | |
   basedOn:SupportedBasedOn | S | 0..* | ReferenceRest(PA Service Request) | What was requested |
| status | 1..1 | code | partial | preliminary | final | amended | corrected | appended | entered-in-error Binding: PA DiagnosticReport Statuses (required) | |
| Slices for category | 1..* | CodeableConcept | Service category Slice: Unordered, Open by pattern:$this | |
 category:PA | S | 1..1 | CodeableConcept | Additional category indicating that the service category is related to physical activity Required Pattern: At least the following |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
| code | 1..1 | CodeableConcept | US Core Report Code Binding: PA DiagnosticReport Types (extensible) | |
| encounter | 0..1 | Reference(US Core Encounter Profile) | Health care event when test ordered | |
| Slices for result | 0..* | Reference(Observation) | Observations Slice: Unordered, Open by profile:resolve() | |
| result:SupportedResult | S | 0..* | ReferenceRest(PA Observation EVS Base S | PA Observation - Supporting, Activity-based S | PA Observation - Supporting, Time-based S | PA Observation - Supporting, Activity Group S) | Observations |
 presentedForm | C | 0..* | Attachment | Entire report as issued pa-dr-1: At least one of data and url must be present. |
| contentType | 0..1 | code | Mime type of the content, with charset etc. Required Pattern: application/pdf | |
| data | SC | 0..1 | base64Binary | Data inline, base64ed |
| url | SC | 0..1 | url | Uri where the data can be found |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.status | required | PADiagnosticReportStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-statusfrom this IG | |
| DiagnosticReport.code | extensible | PADiagnosticReportTypehttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| pa-dr-1 | error | DiagnosticReport.presentedForm | At least one of data and url must be present. : data.exists() or url.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | 0..* | USCoreDiagnosticReportProfileNoteExchange | US Core Diagnostic Report Profile for Report and Note exchange | |
| Slices for basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested Slice: Unordered, Open by profile:resolve() | |
| basedOn:SupportedBasedOn | S | 0..* | ReferenceRest(PA Service Request) | What was requested |
 status | ?!SΣ | 1..1 | code | partial | preliminary | final | amended | corrected | appended | entered-in-error Binding: PA DiagnosticReport Statuses (required) |
| Slices for category | SΣ | 1..* | CodeableConcept | Service category Slice: Unordered, Open by pattern:$this Binding: US Core DiagnosticReport Category (extensible) |
| category:PA | SΣ | 1..1 | CodeableConcept | Additional category indicating that the service category is related to physical activity Binding: US Core DiagnosticReport Category (extensible) Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
 code | SΣ | 1..1 | CodeableConcept | US Core Report Code Binding: PA DiagnosticReport Types (extensible) |
 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 |
| Slices for result | 0..* | Reference(Observation) | Observations Slice: Unordered, Open by profile:resolve() | |
| result:SupportedResult | S | 0..* | ReferenceRest(PA Observation EVS Base | PA Observation - Supporting, Activity-based | PA Observation - Supporting, Time-based | PA Observation - Supporting, Activity Group) | Observations |
| presentedForm | SC | 0..* | Attachment | Entire report as issued pa-dr-1: At least one of data and url must be present. |
| contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf |
| data | SC | 0..1 | base64Binary | Data inline, base64ed |
| url | SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| DiagnosticReport.status | required | PADiagnosticReportStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-statusfrom this IG | |
| DiagnosticReport.category | extensible | USCoreDiagnosticReportCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category | |
| DiagnosticReport.category:PA | extensible | Pattern: PhysicalActivityhttp://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category | |
| DiagnosticReport.code | extensible | PADiagnosticReportTypehttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-typefrom this IG | |
| DiagnosticReport.presentedForm.contentType | required | Pattern: application/pdfhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| pa-dr-1 | error | DiagnosticReport.presentedForm | At least one of data and url must be present. : data.exists() or url.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport | 0..* | USCoreDiagnosticReportProfileNoteExchange | US Core Diagnostic Report Profile for Report and Note exchange | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | |||||
| identifier | Σ | 0..* | Identifier | Business identifier for report | ||||
| Slices for basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested Slice: Unordered, Open by profile:resolve() | |||||
| basedOn:SupportedBasedOn | S | 0..* | ReferenceRest(PA Service Request) | What was requested | ||||
| status | ?!SΣ | 1..1 | code | partial | preliminary | final | amended | corrected | appended | entered-in-error Binding: PA DiagnosticReport Statuses (required) | ||||
| Slices for category | SΣ | 1..* | CodeableConcept | Service category Slice: Unordered, Open by pattern:$this Binding: US Core DiagnosticReport Category (extensible) | ||||
| category:PA | SΣ | 1..1 | CodeableConcept | Additional category indicating that the service category is related to physical activity Binding: US Core DiagnosticReport Category (extensible) Required Pattern: At least the following | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
 text | 0..1 | string | Plain text representation of the concept | |||||
| code | SΣ | 1..1 | CodeableConcept | US Core Report Code Binding: PA DiagnosticReport Types (extensible) | ||||
| 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 | |||||
| Slices for result | 0..* | Reference(Observation) | Observations Slice: Unordered, Open by profile:resolve() | |||||
| result:SupportedResult | S | 0..* | ReferenceRest(PA Observation EVS Base S | PA Observation - Supporting, Activity-based S | PA Observation - Supporting, Time-based S | PA Observation - Supporting, Activity Group S) | 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 | SC | 0..* | Attachment | Entire report as issued pa-dr-1: At least one of data and url must be present. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | SC | 0..1 | base64Binary | Data inline, base64ed | ||||
| url | SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| DiagnosticReport.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DiagnosticReport.status | required | PADiagnosticReportStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-statusfrom this IG | ||||
| DiagnosticReport.category | extensible | USCoreDiagnosticReportCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category | ||||
| DiagnosticReport.category:PA | extensible | Pattern: PhysicalActivityhttp://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category | ||||
| DiagnosticReport.code | extensible | PADiagnosticReportTypehttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-typefrom this IG | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| DiagnosticReport.presentedForm.contentType | required | Pattern: application/pdfhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| DiagnosticReport.presentedForm.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pa-dr-1 | error | DiagnosticReport.presentedForm | At least one of data and url must be present. : data.exists() or url.exists() |
This structure is derived from USCoreDiagnosticReportProfileNoteExchange
Summary
Mandatory: 1 element
Must-Support: 5 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
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 | |
| implicitRules | 0..0 | |||
| modifierExtension | 0..0 | |||
| Slices for basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested Slice: Unordered, Open by profile:resolve() | |
| basedOn:SupportedBasedOn | S | 0..* | ReferenceRest(PA Service Request) | What was requested |
| status | 1..1 | code | partial | preliminary | final | amended | corrected | appended | entered-in-error Binding: PA DiagnosticReport Statuses (required) | |
| Slices for category | 1..* | CodeableConcept | Service category Slice: Unordered, Open by pattern:$this | |
| category:PA | S | 1..1 | CodeableConcept | Additional category indicating that the service category is related to physical activity Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
| code | 1..1 | CodeableConcept | US Core Report Code Binding: PA DiagnosticReport Types (extensible) | |
| encounter | 0..1 | Reference(US Core Encounter Profile) | Health care event when test ordered | |
| Slices for result | 0..* | Reference(Observation) | Observations Slice: Unordered, Open by profile:resolve() | |
| result:SupportedResult | S | 0..* | ReferenceRest(PA Observation EVS Base S | PA Observation - Supporting, Activity-based S | PA Observation - Supporting, Time-based S | PA Observation - Supporting, Activity Group S) | Observations |
| presentedForm | C | 0..* | Attachment | Entire report as issued pa-dr-1: At least one of data and url must be present. |
| contentType | 0..1 | code | Mime type of the content, with charset etc. Required Pattern: application/pdf | |
| data | SC | 0..1 | base64Binary | Data inline, base64ed |
| url | SC | 0..1 | url | Uri where the data can be found |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.status | required | PADiagnosticReportStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-statusfrom this IG | |
| DiagnosticReport.code | extensible | PADiagnosticReportTypehttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| pa-dr-1 | error | DiagnosticReport.presentedForm | At least one of data and url must be present. : data.exists() or url.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | 0..* | USCoreDiagnosticReportProfileNoteExchange | US Core Diagnostic Report Profile for Report and Note exchange | |
| Slices for basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested Slice: Unordered, Open by profile:resolve() | |
| basedOn:SupportedBasedOn | S | 0..* | ReferenceRest(PA Service Request) | What was requested |
| status | ?!SΣ | 1..1 | code | partial | preliminary | final | amended | corrected | appended | entered-in-error Binding: PA DiagnosticReport Statuses (required) |
| Slices for category | SΣ | 1..* | CodeableConcept | Service category Slice: Unordered, Open by pattern:$this Binding: US Core DiagnosticReport Category (extensible) |
| category:PA | SΣ | 1..1 | CodeableConcept | Additional category indicating that the service category is related to physical activity Binding: US Core DiagnosticReport Category (extensible) Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
| code | SΣ | 1..1 | CodeableConcept | US Core Report Code Binding: PA DiagnosticReport Types (extensible) |
| 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 |
| Slices for result | 0..* | Reference(Observation) | Observations Slice: Unordered, Open by profile:resolve() | |
| result:SupportedResult | S | 0..* | ReferenceRest(PA Observation EVS Base | PA Observation - Supporting, Activity-based | PA Observation - Supporting, Time-based | PA Observation - Supporting, Activity Group) | Observations |
| presentedForm | SC | 0..* | Attachment | Entire report as issued pa-dr-1: At least one of data and url must be present. |
| contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf |
| data | SC | 0..1 | base64Binary | Data inline, base64ed |
| url | SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| DiagnosticReport.status | required | PADiagnosticReportStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-statusfrom this IG | |
| DiagnosticReport.category | extensible | USCoreDiagnosticReportCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category | |
| DiagnosticReport.category:PA | extensible | Pattern: PhysicalActivityhttp://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category | |
| DiagnosticReport.code | extensible | PADiagnosticReportTypehttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-typefrom this IG | |
| DiagnosticReport.presentedForm.contentType | required | Pattern: application/pdfhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| pa-dr-1 | error | DiagnosticReport.presentedForm | At least one of data and url must be present. : data.exists() or url.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport | 0..* | USCoreDiagnosticReportProfileNoteExchange | US Core Diagnostic Report Profile for Report and Note exchange | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | |||||
| identifier | Σ | 0..* | Identifier | Business identifier for report | ||||
| Slices for basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested Slice: Unordered, Open by profile:resolve() | |||||
| basedOn:SupportedBasedOn | S | 0..* | ReferenceRest(PA Service Request) | What was requested | ||||
| status | ?!SΣ | 1..1 | code | partial | preliminary | final | amended | corrected | appended | entered-in-error Binding: PA DiagnosticReport Statuses (required) | ||||
| Slices for category | SΣ | 1..* | CodeableConcept | Service category Slice: Unordered, Open by pattern:$this Binding: US Core DiagnosticReport Category (extensible) | ||||
| category:PA | SΣ | 1..1 | CodeableConcept | Additional category indicating that the service category is related to physical activity Binding: US Core DiagnosticReport Category (extensible) Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| code | SΣ | 1..1 | CodeableConcept | US Core Report Code Binding: PA DiagnosticReport Types (extensible) | ||||
| 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 | |||||
| Slices for result | 0..* | Reference(Observation) | Observations Slice: Unordered, Open by profile:resolve() | |||||
| result:SupportedResult | S | 0..* | ReferenceRest(PA Observation EVS Base S | PA Observation - Supporting, Activity-based S | PA Observation - Supporting, Time-based S | PA Observation - Supporting, Activity Group S) | 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 | SC | 0..* | Attachment | Entire report as issued pa-dr-1: At least one of data and url must be present. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | SC | 0..1 | base64Binary | Data inline, base64ed | ||||
| url | SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| DiagnosticReport.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DiagnosticReport.status | required | PADiagnosticReportStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-statusfrom this IG | ||||
| DiagnosticReport.category | extensible | USCoreDiagnosticReportCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category | ||||
| DiagnosticReport.category:PA | extensible | Pattern: PhysicalActivityhttp://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category | ||||
| DiagnosticReport.code | extensible | PADiagnosticReportTypehttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-typefrom this IG | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| DiagnosticReport.presentedForm.contentType | required | Pattern: application/pdfhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard | ||||
| DiagnosticReport.presentedForm.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pa-dr-1 | error | DiagnosticReport.presentedForm | At least one of data and url must be present. : data.exists() or url.exists() |
This structure is derived from USCoreDiagnosticReportProfileNoteExchange
Summary
Mandatory: 1 element
Must-Support: 5 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Patient Care. Package hl7.fhir.us.physical-activity#1.0.1 based on FHIR 4.0.1. Generated 2024-03-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change