JohnMoehrke PHR FHIR API
0.5.2 - ci-build United States of America flag

JohnMoehrke PHR FHIR API, published by John Moehrke (himself). This guide is not an authorized publication; it is the continuous build for version 0.5.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/JohnMoehrke/phr/ and changes regularly. See the Directory of published versions

Resource Profile: VA MHV PHR HDR Chem-Hem Report

Official URL: http://johnmoehrke.github.io/phr/StructureDefinition/JFM.PHR.chReport Version: 0.5.2
Standards status: Trial-use Maturity Level: 3 Computable Name: JFMchReport

Profile on DiagnosticReport for Chem-Hem lab report.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:note S 0..* string Notes
URL: http://johnmoehrke.github.io/phr/StructureDefinition/Notes
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 1..* Identifier Business identifier for report
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:Rid Σ 0..1 Identifier Business identifier for report
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: usual
..... system Σ 0..1 uri DNS universalIdType: `urn:fdc:` + {universalID} + `:` + {namespaceId}
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string {labTestPromises.recordIdentifier.identity}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:TOid Σ 0..1 Identifier Business identifier for report
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: secondary
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
ele-1: All FHIR elements must have a @value or children
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `recordIdentifier.identifier` | `/` | {specimentTakenDate.literal}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... basedOn S 1..* Reference(VA MHV PHR CH labTests.orderedTestCode) {c} What was requested
ele-1: All FHIR elements must have a @value or children
... status ?!SΣC 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
ele-1: All FHIR elements must have a @value or children
... Slices for category SΣ 2..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


ele-1: All FHIR elements must have a @value or children
.... category:LaboratorySlice SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


ele-1: All FHIR elements must have a @value or children

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://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
.... category:ChSlice SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


ele-1: All FHIR elements must have a @value or children

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://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CH
... code SΣ 1..1 CodeableConcept US Core Laboratory Report Order Code
Binding: US Core Diagnostic Report Laboratory Codes (extensible): LOINC codes


ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: CH
... subject SΣ 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
ele-1: All FHIR elements must have a @value or children
... Slices for effective[x] SΣC 1..1 dateTime Diagnostically relevant time (typically the time of specimen collection)
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime Diagnostically relevant time (typically the time of specimen collection)
ele-1: All FHIR elements must have a @value or children
... issued SΣC 1..1 instant When the report was released
ele-1: All FHIR elements must have a @value or children
... performer SΣ 1..1 Reference(VA MHV PHR Organization) {c} recordSource
ele-1: All FHIR elements must have a @value or children
... specimen S 1..1 Reference(VA MHV PHR HDR CH Specimen) {c} Specimens this report is based on
ele-1: All FHIR elements must have a @value or children
... result S 0..* Reference(VA MHV PHR CH labTest.chemistryResults) {c} Observations
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.identifier:Rid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:TOid.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:LaboratorySliceexamplePattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:ChSliceexamplePattern: CH
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleUSCoreDiagnosticReportLabCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-lab-codes

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreDiagnosticReportProfileLaboratoryReporting

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:note S 0..* string Notes
URL: http://johnmoehrke.github.io/phr/StructureDefinition/Notes
... Slices for identifier 1..* Identifier Business identifier for report
Slice: Unordered, Open by value:use
.... identifier:Rid 0..1 Identifier Business identifier for report
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system 0..1 uri DNS universalIdType: `urn:fdc:` + {universalID} + `:` + {namespaceId}
..... value 0..1 string {labTestPromises.recordIdentifier.identity}
.... identifier:TOid 0..1 Identifier Business identifier for report
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `recordIdentifier.identifier` | `/` | {specimentTakenDate.literal}
... basedOn S 1..* Reference(VA MHV PHR CH labTests.orderedTestCode) {c} What was requested
... status 1..1 code registered | partial | preliminary | final +
... category 2..* CodeableConcept Service category
... Slices for category Content/Rules for all slices
.... category:ChSlice 1..1 CodeableConcept Service category
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://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CH
... code
.... coding 0..0
.... text S 1..1 string Plain text representation of the concept
Required Pattern: CH
... subject 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
... encounter 0..0
... Slices for effective[x] 1..1 dateTime Diagnostically relevant time (typically the time of specimen collection)
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 1..1 dateTime S Diagnostically relevant time (typically the time of specimen collection)
... issued 1..1 instant When the report was released
... performer 1..1 Reference(VA MHV PHR Organization) {c} recordSource
... resultsInterpreter 0..0
... specimen S 1..1 Reference(VA MHV PHR HDR CH Specimen) {c} Specimens this report is based on
... result 0..* Reference(VA MHV PHR CH labTest.chemistryResults) {c} Observations
... imagingStudy 0..0
... media 0..0
... conclusion 0..0
... conclusionCode 0..0
... presentedForm 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... id Σ 0..1 id 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): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:note S 0..* string Notes
URL: http://johnmoehrke.github.io/phr/StructureDefinition/Notes
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Business identifier for report
Slice: Unordered, Open by value:use
.... identifier:Rid Σ 0..1 Identifier Business identifier for report
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri DNS universalIdType: `urn:fdc:` + {universalID} + `:` + {namespaceId}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string {labTestPromises.recordIdentifier.identity}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:TOid Σ 0..1 Identifier Business identifier for report
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `recordIdentifier.identifier` | `/` | {specimentTakenDate.literal}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... basedOn S 1..* Reference(VA MHV PHR CH labTests.orderedTestCode) {c} What was requested
... status ?!SΣC 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category SΣ 2..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


.... category:LaboratorySlice SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.



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://terminology.hl7.org/CodeSystem/v2-0074
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
...... 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
.... category:ChSlice SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.



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://terminology.hl7.org/CodeSystem/v2-0074
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CH
...... 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 Laboratory Report Order Code
Binding: US Core Diagnostic Report Laboratory Codes (extensible): LOINC codes

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... text SΣ 1..1 string Plain text representation of the concept
Required Pattern: CH
... subject SΣ 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
... Slices for effective[x] SΣC 1..1 dateTime S Diagnostically relevant time (typically the time of specimen collection)
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime S Diagnostically relevant time (typically the time of specimen collection)
... issued SΣC 1..1 instant When the report was released
... performer SΣ 1..1 Reference(VA MHV PHR Organization) {c} recordSource
... specimen S 1..1 Reference(VA MHV PHR HDR CH Specimen) {c} Specimens this report is based on
... result S 0..* Reference(VA MHV PHR CH labTest.chemistryResults) {c} Observations

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DiagnosticReport.identifier:Rid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:Rid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.identifier:TOid.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:LaboratorySliceexamplePattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:ChSliceexamplePattern: CH
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleUSCoreDiagnosticReportLabCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-lab-codes

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreDiagnosticReportProfileLaboratoryReporting

Summary

Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 5 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.identifier
  • The element 1 is sliced based on the value of DiagnosticReport.effective[x]

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:note S 0..* string Notes
URL: http://johnmoehrke.github.io/phr/StructureDefinition/Notes
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 1..* Identifier Business identifier for report
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:Rid Σ 0..1 Identifier Business identifier for report
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: usual
..... system Σ 0..1 uri DNS universalIdType: `urn:fdc:` + {universalID} + `:` + {namespaceId}
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string {labTestPromises.recordIdentifier.identity}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:TOid Σ 0..1 Identifier Business identifier for report
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: secondary
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
ele-1: All FHIR elements must have a @value or children
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `recordIdentifier.identifier` | `/` | {specimentTakenDate.literal}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... basedOn S 1..* Reference(VA MHV PHR CH labTests.orderedTestCode) {c} What was requested
ele-1: All FHIR elements must have a @value or children
... status ?!SΣC 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
ele-1: All FHIR elements must have a @value or children
... Slices for category SΣ 2..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


ele-1: All FHIR elements must have a @value or children
.... category:LaboratorySlice SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


ele-1: All FHIR elements must have a @value or children

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://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
.... category:ChSlice SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


ele-1: All FHIR elements must have a @value or children

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://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CH
... code SΣ 1..1 CodeableConcept US Core Laboratory Report Order Code
Binding: US Core Diagnostic Report Laboratory Codes (extensible): LOINC codes


ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: CH
... subject SΣ 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
ele-1: All FHIR elements must have a @value or children
... Slices for effective[x] SΣC 1..1 dateTime Diagnostically relevant time (typically the time of specimen collection)
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime Diagnostically relevant time (typically the time of specimen collection)
ele-1: All FHIR elements must have a @value or children
... issued SΣC 1..1 instant When the report was released
ele-1: All FHIR elements must have a @value or children
... performer SΣ 1..1 Reference(VA MHV PHR Organization) {c} recordSource
ele-1: All FHIR elements must have a @value or children
... specimen S 1..1 Reference(VA MHV PHR HDR CH Specimen) {c} Specimens this report is based on
ele-1: All FHIR elements must have a @value or children
... result S 0..* Reference(VA MHV PHR CH labTest.chemistryResults) {c} Observations
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.identifier:Rid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:TOid.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:LaboratorySliceexamplePattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:ChSliceexamplePattern: CH
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleUSCoreDiagnosticReportLabCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-lab-codes

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Differential View

This structure is derived from USCoreDiagnosticReportProfileLaboratoryReporting

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:note S 0..* string Notes
URL: http://johnmoehrke.github.io/phr/StructureDefinition/Notes
... Slices for identifier 1..* Identifier Business identifier for report
Slice: Unordered, Open by value:use
.... identifier:Rid 0..1 Identifier Business identifier for report
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system 0..1 uri DNS universalIdType: `urn:fdc:` + {universalID} + `:` + {namespaceId}
..... value 0..1 string {labTestPromises.recordIdentifier.identity}
.... identifier:TOid 0..1 Identifier Business identifier for report
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `recordIdentifier.identifier` | `/` | {specimentTakenDate.literal}
... basedOn S 1..* Reference(VA MHV PHR CH labTests.orderedTestCode) {c} What was requested
... status 1..1 code registered | partial | preliminary | final +
... category 2..* CodeableConcept Service category
... Slices for category Content/Rules for all slices
.... category:ChSlice 1..1 CodeableConcept Service category
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://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CH
... code
.... coding 0..0
.... text S 1..1 string Plain text representation of the concept
Required Pattern: CH
... subject 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
... encounter 0..0
... Slices for effective[x] 1..1 dateTime Diagnostically relevant time (typically the time of specimen collection)
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 1..1 dateTime S Diagnostically relevant time (typically the time of specimen collection)
... issued 1..1 instant When the report was released
... performer 1..1 Reference(VA MHV PHR Organization) {c} recordSource
... resultsInterpreter 0..0
... specimen S 1..1 Reference(VA MHV PHR HDR CH Specimen) {c} Specimens this report is based on
... result 0..* Reference(VA MHV PHR CH labTest.chemistryResults) {c} Observations
... imagingStudy 0..0
... media 0..0
... conclusion 0..0
... conclusionCode 0..0
... presentedForm 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... id Σ 0..1 id 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): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:note S 0..* string Notes
URL: http://johnmoehrke.github.io/phr/StructureDefinition/Notes
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Business identifier for report
Slice: Unordered, Open by value:use
.... identifier:Rid Σ 0..1 Identifier Business identifier for report
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri DNS universalIdType: `urn:fdc:` + {universalID} + `:` + {namespaceId}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string {labTestPromises.recordIdentifier.identity}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:TOid Σ 0..1 Identifier Business identifier for report
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `recordIdentifier.identifier` | `/` | {specimentTakenDate.literal}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... basedOn S 1..* Reference(VA MHV PHR CH labTests.orderedTestCode) {c} What was requested
... status ?!SΣC 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category SΣ 2..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


.... category:LaboratorySlice SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.



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://terminology.hl7.org/CodeSystem/v2-0074
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
...... 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
.... category:ChSlice SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.



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://terminology.hl7.org/CodeSystem/v2-0074
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CH
...... 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 Laboratory Report Order Code
Binding: US Core Diagnostic Report Laboratory Codes (extensible): LOINC codes

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... text SΣ 1..1 string Plain text representation of the concept
Required Pattern: CH
... subject SΣ 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
... Slices for effective[x] SΣC 1..1 dateTime S Diagnostically relevant time (typically the time of specimen collection)
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime S Diagnostically relevant time (typically the time of specimen collection)
... issued SΣC 1..1 instant When the report was released
... performer SΣ 1..1 Reference(VA MHV PHR Organization) {c} recordSource
... specimen S 1..1 Reference(VA MHV PHR HDR CH Specimen) {c} Specimens this report is based on
... result S 0..* Reference(VA MHV PHR CH labTest.chemistryResults) {c} Observations

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DiagnosticReport.identifier:Rid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:Rid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.identifier:TOid.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:LaboratorySliceexamplePattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:ChSliceexamplePattern: CH
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleUSCoreDiagnosticReportLabCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-lab-codes

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreDiagnosticReportProfileLaboratoryReporting

Summary

Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 5 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.identifier
  • The element 1 is sliced based on the value of DiagnosticReport.effective[x]

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron