Magentus Practice Management FHIR Implementation Guide
1.2.16 - ci-build

Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.16) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Diagnostic Imaging Report Transaction Report Entry

Official URL: http://fhir.geniesolutions.io/StructureDefinition/gs-imagingreport-entry-report Version: 1.2.16
Draft as of 2024-08-15 Computable Name: GSImagingReportEntryReport

Diagnostic Imaging Report Transaction Report Entry

Usage:

Formal Views of Profile Content

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

This structure is derived from AUCoreDiagnosticReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* AUCoreDiagnosticReport A diagnostic report in an Australian healthcare context
... Slices for contained S 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
.... contained:encounter S 0..1 AUCoreEncounter An encounter in an Australian healthcare context
..... status 1..1 code finished
Fixed Value: finished
..... class 1..1 Coding Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory)
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AMB
..... subject
...... reference 1..1 string FullUrl reference to Patient resource within bundle
... Slices for identifier 1..* Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber Business identifier for report
Slice: Unordered, Open by value:type
.... identifier:order-number S 0..* AULocalOrderIdentifier Local Order Identifier
.... identifier:report-id S 1..1 AULocalReportIdentifier Local Report Identifier
.... identifier:accession-number S 0..1 AUAccessionNumber Accession Number
... basedOn
.... reference 1..1 string FullUrl reference to ServiceRequest resource within bundle
... status 1..1 code final | preliminary | corrected
... category 1..1 CodeableConcept Service category
... subject
.... reference 1..1 string FullUrl reference to Patient resource within bundle
... encounter S 0..1 Reference(AU Core Encounter) Health care event when test ordered
.... reference 1..1 string Reference to contained Encounter resource
... Slices for effective[x] 1..1 dateTime, Period Clinically relevant time/time-period for report
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 0..1 dateTime Clinically relevant time/time-period for report
... performer 1..1 Reference(AU Core Organization | AU Core PractitionerRole) Responsible Diagnostic Service
.... reference 1..1 string FullUrl reference to Organization or PractitionerRole resource within bundle
... presentedForm 0..1 Attachment Entire report as issued
.... contentType 1..1 code Mime type of the content, with charset etc.
Fixed Value: application/pdf
.... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* AUCoreDiagnosticReport A diagnostic report in an Australian healthcare context
au-core-dir-01: The report shall at least have a result or a presentedForm
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for contained S 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
.... contained:encounter S 0..1 AUCoreEncounter An encounter in an Australian healthcare context
..... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
..... Slices for extension Content/Rules for all slices
...... encounterDescription S 0..1 string Description, overview or summary of an encounter
URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
...... associatedHealthcareService 0..* Reference(HealthcareService) Associated healthcare service
URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known
..... status ?!SΣ 1..1 code finished
Binding: EncounterStatus (required): Current state of the encounter.


Fixed Value: finished
..... class SΣ 1..1 Coding Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory)
Binding: ActEncounterCode - AU Extended (extensible)
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AMB
..... type SΣ 0..* CodeableConcept Specific type of encounter
Binding: Encounter Type . (preferred)
..... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: Service Type . (preferred)
..... subject SΣ 1..1 Reference(AU Core Patient) The patient or group present at the encounter
...... reference ΣC 1..1 string FullUrl reference to Patient resource within bundle
..... participant SΣ 0..* BackboneElement List of participants involved in the encounter
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


...... individual SΣ 0..1 Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) Persons involved in the encounter other than the patient
..... period S 1..1 Period The start and end time of the encounter
..... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


..... reasonReference SΣ 0..* Reference(AU Core Condition | AU Core Observation | AU Core Procedure) Reason the encounter takes place (reference)
..... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... dischargeDisposition S 0..1 CodeableConcept Separation Mode
Binding: Separation Mode . (extensible)
..... location S 0..* BackboneElement List of locations where the patient has been
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... location S 1..1 Reference(AU Core Location) Location the encounter takes place
..... serviceProvider S 0..1 Reference(AU Core Organization) The organization (facility) responsible for this encounter
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber Business identifier for report
Slice: Unordered, Open by value:type
.... identifier:order-number S 0..* AULocalOrderIdentifier Local Order Identifier
.... identifier:report-id S 1..1 AULocalReportIdentifier Local Report Identifier
.... identifier:accession-number S 0..1 AUAccessionNumber Accession Number
... basedOn S 0..* Reference(AU Core ServiceRequest) Diagnostic investigation order
.... reference ΣC 1..1 string FullUrl reference to ServiceRequest resource within bundle
... status ?!SΣ 1..1 code final | preliminary | corrected
Binding: DiagnosticReportStatus Report Available . (required)
... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (extensible)
... code SΣ 1..1 CodeableConcept Diagnostic examination name / study name / group name
Binding: Evaluation Procedure . (preferred)
... subject SΣ 1..1 Reference(AU Core Patient) The subject of the report - usually, but not always, the patient
.... reference ΣC 1..1 string FullUrl reference to Patient resource within bundle
... encounter SΣ 0..1 Reference(AU Core Encounter) Health care event when test ordered
.... reference ΣC 1..1 string Reference to contained Encounter resource
... Slices for effective[x] SΣC 1..1 Clinically relevant time/time-period for report
Slice: Unordered, Open by type:$this
au-core-dir-04: Date shall be at least to day
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime Clinically relevant time/time-period for report
au-core-dir-04: Date shall be at least to day
... issued SΣ 1..1 instant Diagnostic report date time
... performer SΣ 1..1 Reference(AU Core Organization | AU Core PractitionerRole) Responsible Diagnostic Service
.... reference ΣC 1..1 string FullUrl reference to Organization or PractitionerRole resource within bundle
... result SC 0..* Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation) Observations
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... media SΣ 0..* BackboneElement Key images associated with this report
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... link SΣ 1..1 Reference(Media) Reference to the image source
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode S 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: Clinical Finding . (preferred)
... presentedForm SC 0..1 Attachment Entire report as issued
.... contentType Σ 1..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.


Fixed Value: application/pdf
.... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.contained:encounter.statusrequiredFixed Value: finished
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
DiagnosticReport.contained:encounter.classextensiblePattern: AMB
http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
DiagnosticReport.contained:encounter.typepreferredEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
DiagnosticReport.contained:encounter.serviceTypepreferredServiceType .
https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
DiagnosticReport.contained:encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
DiagnosticReport.contained:encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.dischargeDispositionextensibleSeparationMode . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)
https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1
DiagnosticReport.statusrequiredDiagnosticReportStatusReportAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensibleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codepreferredEvaluationProcedure .
https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
DiagnosticReport.conclusionCodepreferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
DiagnosticReport.presentedForm.contentTyperequiredFixed Value: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-dir-01errorDiagnosticReportThe report shall at least have a result or a presentedForm
: result.exists() or presentedForm.exists()
au-core-dir-04errorDiagnosticReport.effective[x], DiagnosticReport.effective[x]:effectiveDateTimeDate shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* AUCoreDiagnosticReport A diagnostic report in an Australian healthcare context
au-core-dir-01: The report shall at least have a result or a presentedForm
... 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
... Slices for contained S 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
.... contained:encounter S 0..1 AUCoreEncounter An encounter in an Australian healthcare context
..... 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
...... encounterDescription S 0..1 string Description, overview or summary of an encounter
URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
...... associatedHealthcareService 0..* Reference(HealthcareService) Associated healthcare service
URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known
..... status ?!SΣ 1..1 code finished
Binding: EncounterStatus (required): Current state of the encounter.


Fixed Value: finished
..... statusHistory 0..* BackboneElement List of past encounter statuses
...... 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
...... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

...... period 1..1 Period The time that the episode was in the specified status
..... class SΣ 1..1 Coding Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory)
Binding: ActEncounterCode - AU Extended (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
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AMB
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... classHistory 0..* BackboneElement List of past encounter classes
...... 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
...... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

...... period 1..1 Period The time that the episode was in the specified class
..... type SΣ 0..* CodeableConcept Specific type of encounter
Binding: Encounter Type . (preferred)
..... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: Service Type . (preferred)
..... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

..... subject SΣ 1..1 Reference(AU Core Patient) The patient or group present at the encounter
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string FullUrl reference to Patient resource within bundle
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
..... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
..... participant SΣ 0..* BackboneElement List of participants involved in the encounter
...... 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
...... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


...... period 0..1 Period Period of time during the encounter that the participant participated
...... individual SΣ 0..1 Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) Persons involved in the encounter other than the patient
..... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
..... period S 1..1 Period The start and end time of the encounter
..... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
..... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


..... reasonReference SΣ 0..* Reference(AU Core Condition | AU Core Observation | AU Core Procedure) Reason the encounter takes place (reference)
..... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
...... 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
...... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
...... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

...... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
..... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
..... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
...... 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
...... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
...... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
...... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

...... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.

...... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


...... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.


...... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.


...... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
...... dischargeDisposition S 0..1 CodeableConcept Separation Mode
Binding: Separation Mode . (extensible)
..... location S 0..* BackboneElement List of locations where the patient has been
...... 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
...... location S 1..1 Reference(AU Core Location) Location the encounter takes place
...... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

...... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.

...... period 0..1 Period Time period during which the patient was present at the location
..... serviceProvider S 0..1 Reference(AU Core Organization) The organization (facility) responsible for this encounter
..... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber Business identifier for report
Slice: Unordered, Open by value:type
.... identifier:order-number S 0..* AULocalOrderIdentifier Local Order Identifier
.... identifier:report-id S 1..1 AULocalReportIdentifier Local Report Identifier
.... identifier:accession-number S 0..1 AUAccessionNumber Accession Number
... basedOn S 0..* Reference(AU Core ServiceRequest) Diagnostic investigation order
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string FullUrl reference to ServiceRequest resource within bundle
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... status ?!SΣ 1..1 code final | preliminary | corrected
Binding: DiagnosticReportStatus Report Available . (required)
... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (extensible)
... code SΣ 1..1 CodeableConcept Diagnostic examination name / study name / group name
Binding: Evaluation Procedure . (preferred)
... subject SΣ 1..1 Reference(AU Core Patient) The subject of the report - usually, but not always, the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string FullUrl reference to Patient resource within bundle
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter SΣ 0..1 Reference(AU Core Encounter) Health care event when test ordered
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Reference to contained Encounter resource
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for effective[x] SΣC 1..1 Clinically relevant time/time-period for report
Slice: Unordered, Open by type:$this
au-core-dir-04: Date shall be at least to day
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime Clinically relevant time/time-period for report
au-core-dir-04: Date shall be at least to day
... issued SΣ 1..1 instant Diagnostic report date time
... performer SΣ 1..1 Reference(AU Core Organization | AU Core PractitionerRole) Responsible Diagnostic Service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string FullUrl reference to Organization or PractitionerRole resource within bundle
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... resultsInterpreter Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam) Primary result interpreter
... specimen 0..* Reference(AU Base Specimen) Specimens this report is based on
... result SC 0..* Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation) Observations
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... imagingStudy 0..* Reference(ImagingStudy) Reference to full details of imaging associated with the diagnostic report
... media SΣ 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 SΣ 1..1 Reference(Media) Reference to the image source
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode S 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: Clinical Finding . (preferred)
... presentedForm SC 0..1 Attachment Entire report as issued
.... 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 Σ 1..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.


Fixed Value: application/pdf
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 1..1 base64Binary Data inline, base64ed
.... url Σ 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.contained:encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.contained:encounter.statusrequiredFixed Value: finished
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
DiagnosticReport.contained:encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
DiagnosticReport.contained:encounter.classextensiblePattern: AMB
http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
DiagnosticReport.contained:encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
DiagnosticReport.contained:encounter.typepreferredEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
DiagnosticReport.contained:encounter.serviceTypepreferredServiceType .
https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
DiagnosticReport.contained:encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
DiagnosticReport.contained:encounter.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.contained:encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
DiagnosticReport.contained:encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
DiagnosticReport.contained:encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
DiagnosticReport.contained:encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.dischargeDispositionextensibleSeparationMode . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)
https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1
DiagnosticReport.contained:encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
DiagnosticReport.contained:encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
DiagnosticReport.basedOn.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatusReportAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensibleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codepreferredEvaluationProcedure .
https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
DiagnosticReport.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.performer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.result.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.conclusionCodepreferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
DiagnosticReport.presentedForm.contentTyperequiredFixed Value: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DiagnosticReport.presentedForm.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-dir-01errorDiagnosticReportThe report shall at least have a result or a presentedForm
: result.exists() or presentedForm.exists()
au-core-dir-04errorDiagnosticReport.effective[x], DiagnosticReport.effective[x]:effectiveDateTimeDate shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUCoreDiagnosticReport

Summary

Mandatory: 3 elements(5 nested mandatory elements)
Must-Support: 7 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.contained
  • 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]

Differential View

This structure is derived from AUCoreDiagnosticReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* AUCoreDiagnosticReport A diagnostic report in an Australian healthcare context
... Slices for contained S 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
.... contained:encounter S 0..1 AUCoreEncounter An encounter in an Australian healthcare context
..... status 1..1 code finished
Fixed Value: finished
..... class 1..1 Coding Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory)
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AMB
..... subject
...... reference 1..1 string FullUrl reference to Patient resource within bundle
... Slices for identifier 1..* Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber Business identifier for report
Slice: Unordered, Open by value:type
.... identifier:order-number S 0..* AULocalOrderIdentifier Local Order Identifier
.... identifier:report-id S 1..1 AULocalReportIdentifier Local Report Identifier
.... identifier:accession-number S 0..1 AUAccessionNumber Accession Number
... basedOn
.... reference 1..1 string FullUrl reference to ServiceRequest resource within bundle
... status 1..1 code final | preliminary | corrected
... category 1..1 CodeableConcept Service category
... subject
.... reference 1..1 string FullUrl reference to Patient resource within bundle
... encounter S 0..1 Reference(AU Core Encounter) Health care event when test ordered
.... reference 1..1 string Reference to contained Encounter resource
... Slices for effective[x] 1..1 dateTime, Period Clinically relevant time/time-period for report
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 0..1 dateTime Clinically relevant time/time-period for report
... performer 1..1 Reference(AU Core Organization | AU Core PractitionerRole) Responsible Diagnostic Service
.... reference 1..1 string FullUrl reference to Organization or PractitionerRole resource within bundle
... presentedForm 0..1 Attachment Entire report as issued
.... contentType 1..1 code Mime type of the content, with charset etc.
Fixed Value: application/pdf
.... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* AUCoreDiagnosticReport A diagnostic report in an Australian healthcare context
au-core-dir-01: The report shall at least have a result or a presentedForm
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for contained S 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
.... contained:encounter S 0..1 AUCoreEncounter An encounter in an Australian healthcare context
..... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
..... Slices for extension Content/Rules for all slices
...... encounterDescription S 0..1 string Description, overview or summary of an encounter
URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
...... associatedHealthcareService 0..* Reference(HealthcareService) Associated healthcare service
URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known
..... status ?!SΣ 1..1 code finished
Binding: EncounterStatus (required): Current state of the encounter.


Fixed Value: finished
..... class SΣ 1..1 Coding Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory)
Binding: ActEncounterCode - AU Extended (extensible)
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AMB
..... type SΣ 0..* CodeableConcept Specific type of encounter
Binding: Encounter Type . (preferred)
..... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: Service Type . (preferred)
..... subject SΣ 1..1 Reference(AU Core Patient) The patient or group present at the encounter
...... reference ΣC 1..1 string FullUrl reference to Patient resource within bundle
..... participant SΣ 0..* BackboneElement List of participants involved in the encounter
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


...... individual SΣ 0..1 Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) Persons involved in the encounter other than the patient
..... period S 1..1 Period The start and end time of the encounter
..... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


..... reasonReference SΣ 0..* Reference(AU Core Condition | AU Core Observation | AU Core Procedure) Reason the encounter takes place (reference)
..... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... dischargeDisposition S 0..1 CodeableConcept Separation Mode
Binding: Separation Mode . (extensible)
..... location S 0..* BackboneElement List of locations where the patient has been
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... location S 1..1 Reference(AU Core Location) Location the encounter takes place
..... serviceProvider S 0..1 Reference(AU Core Organization) The organization (facility) responsible for this encounter
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber Business identifier for report
Slice: Unordered, Open by value:type
.... identifier:order-number S 0..* AULocalOrderIdentifier Local Order Identifier
.... identifier:report-id S 1..1 AULocalReportIdentifier Local Report Identifier
.... identifier:accession-number S 0..1 AUAccessionNumber Accession Number
... basedOn S 0..* Reference(AU Core ServiceRequest) Diagnostic investigation order
.... reference ΣC 1..1 string FullUrl reference to ServiceRequest resource within bundle
... status ?!SΣ 1..1 code final | preliminary | corrected
Binding: DiagnosticReportStatus Report Available . (required)
... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (extensible)
... code SΣ 1..1 CodeableConcept Diagnostic examination name / study name / group name
Binding: Evaluation Procedure . (preferred)
... subject SΣ 1..1 Reference(AU Core Patient) The subject of the report - usually, but not always, the patient
.... reference ΣC 1..1 string FullUrl reference to Patient resource within bundle
... encounter SΣ 0..1 Reference(AU Core Encounter) Health care event when test ordered
.... reference ΣC 1..1 string Reference to contained Encounter resource
... Slices for effective[x] SΣC 1..1 Clinically relevant time/time-period for report
Slice: Unordered, Open by type:$this
au-core-dir-04: Date shall be at least to day
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime Clinically relevant time/time-period for report
au-core-dir-04: Date shall be at least to day
... issued SΣ 1..1 instant Diagnostic report date time
... performer SΣ 1..1 Reference(AU Core Organization | AU Core PractitionerRole) Responsible Diagnostic Service
.... reference ΣC 1..1 string FullUrl reference to Organization or PractitionerRole resource within bundle
... result SC 0..* Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation) Observations
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... media SΣ 0..* BackboneElement Key images associated with this report
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... link SΣ 1..1 Reference(Media) Reference to the image source
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode S 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: Clinical Finding . (preferred)
... presentedForm SC 0..1 Attachment Entire report as issued
.... contentType Σ 1..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.


Fixed Value: application/pdf
.... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.contained:encounter.statusrequiredFixed Value: finished
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
DiagnosticReport.contained:encounter.classextensiblePattern: AMB
http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
DiagnosticReport.contained:encounter.typepreferredEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
DiagnosticReport.contained:encounter.serviceTypepreferredServiceType .
https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
DiagnosticReport.contained:encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
DiagnosticReport.contained:encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.dischargeDispositionextensibleSeparationMode . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)
https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1
DiagnosticReport.statusrequiredDiagnosticReportStatusReportAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensibleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codepreferredEvaluationProcedure .
https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
DiagnosticReport.conclusionCodepreferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
DiagnosticReport.presentedForm.contentTyperequiredFixed Value: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-dir-01errorDiagnosticReportThe report shall at least have a result or a presentedForm
: result.exists() or presentedForm.exists()
au-core-dir-04errorDiagnosticReport.effective[x], DiagnosticReport.effective[x]:effectiveDateTimeDate shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* AUCoreDiagnosticReport A diagnostic report in an Australian healthcare context
au-core-dir-01: The report shall at least have a result or a presentedForm
... 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
... Slices for contained S 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
.... contained:encounter S 0..1 AUCoreEncounter An encounter in an Australian healthcare context
..... 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
...... encounterDescription S 0..1 string Description, overview or summary of an encounter
URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description
...... associatedHealthcareService 0..* Reference(HealthcareService) Associated healthcare service
URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice
..... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
..... identifier SΣ 0..* Identifier Identifier(s) by which this encounter is known
..... status ?!SΣ 1..1 code finished
Binding: EncounterStatus (required): Current state of the encounter.


Fixed Value: finished
..... statusHistory 0..* BackboneElement List of past encounter statuses
...... 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
...... status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.

...... period 1..1 Period The time that the episode was in the specified status
..... class SΣ 1..1 Coding Assumes the encounter where the request was made is Outpatient (i.e. AMB ambulatory)
Binding: ActEncounterCode - AU Extended (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
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AMB
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... classHistory 0..* BackboneElement List of past encounter classes
...... 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
...... class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.

...... period 1..1 Period The time that the episode was in the specified class
..... type SΣ 0..* CodeableConcept Specific type of encounter
Binding: Encounter Type . (preferred)
..... serviceType SΣ 0..1 CodeableConcept Specific type of service
Binding: Service Type . (preferred)
..... priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.

..... subject SΣ 1..1 Reference(AU Core Patient) The patient or group present at the encounter
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 1..1 string FullUrl reference to Patient resource within bundle
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
..... basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
..... participant SΣ 0..* BackboneElement List of participants involved in the encounter
...... 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
...... type SΣ 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.


...... period 0..1 Period Period of time during the encounter that the participant participated
...... individual SΣ 0..1 Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) Persons involved in the encounter other than the patient
..... appointment Σ 0..* Reference(Appointment) The appointment that scheduled this encounter
..... period S 1..1 Period The start and end time of the encounter
..... length 0..1 Duration Quantity of time the encounter lasted (less time absent)
..... reasonCode SΣ 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.


..... reasonReference SΣ 0..* Reference(AU Core Condition | AU Core Observation | AU Core Procedure) Reason the encounter takes place (reference)
..... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
...... 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
...... condition Σ 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
...... use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

...... rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
..... account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
..... hospitalization S 0..1 BackboneElement Details about the admission to a healthcare service
...... 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
...... preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
...... origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
...... admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.

...... reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.

...... dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.


...... specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.


...... specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.


...... destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
...... dischargeDisposition S 0..1 CodeableConcept Separation Mode
Binding: Separation Mode . (extensible)
..... location S 0..* BackboneElement List of locations where the patient has been
...... 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
...... location S 1..1 Reference(AU Core Location) Location the encounter takes place
...... status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.

...... physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.

...... period 0..1 Period Time period during which the patient was present at the location
..... serviceProvider S 0..1 Reference(AU Core Organization) The organization (facility) responsible for this encounter
..... partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber Business identifier for report
Slice: Unordered, Open by value:type
.... identifier:order-number S 0..* AULocalOrderIdentifier Local Order Identifier
.... identifier:report-id S 1..1 AULocalReportIdentifier Local Report Identifier
.... identifier:accession-number S 0..1 AUAccessionNumber Accession Number
... basedOn S 0..* Reference(AU Core ServiceRequest) Diagnostic investigation order
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string FullUrl reference to ServiceRequest resource within bundle
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... status ?!SΣ 1..1 code final | preliminary | corrected
Binding: DiagnosticReportStatus Report Available . (required)
... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (extensible)
... code SΣ 1..1 CodeableConcept Diagnostic examination name / study name / group name
Binding: Evaluation Procedure . (preferred)
... subject SΣ 1..1 Reference(AU Core Patient) The subject of the report - usually, but not always, the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string FullUrl reference to Patient resource within bundle
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter SΣ 0..1 Reference(AU Core Encounter) Health care event when test ordered
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Reference to contained Encounter resource
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for effective[x] SΣC 1..1 Clinically relevant time/time-period for report
Slice: Unordered, Open by type:$this
au-core-dir-04: Date shall be at least to day
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime Clinically relevant time/time-period for report
au-core-dir-04: Date shall be at least to day
... issued SΣ 1..1 instant Diagnostic report date time
... performer SΣ 1..1 Reference(AU Core Organization | AU Core PractitionerRole) Responsible Diagnostic Service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string FullUrl reference to Organization or PractitionerRole resource within bundle
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... resultsInterpreter Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam) Primary result interpreter
... specimen 0..* Reference(AU Base Specimen) Specimens this report is based on
... result SC 0..* Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation) Observations
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... imagingStudy 0..* Reference(ImagingStudy) Reference to full details of imaging associated with the diagnostic report
... media SΣ 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 SΣ 1..1 Reference(Media) Reference to the image source
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode S 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: Clinical Finding . (preferred)
... presentedForm SC 0..1 Attachment Entire report as issued
.... 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 Σ 1..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.


Fixed Value: application/pdf
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 1..1 base64Binary Data inline, base64ed
.... url Σ 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.contained:encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.contained:encounter.statusrequiredFixed Value: finished
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
DiagnosticReport.contained:encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
from the FHIR Standard
DiagnosticReport.contained:encounter.classextensiblePattern: AMB
http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
DiagnosticReport.contained:encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
DiagnosticReport.contained:encounter.typepreferredEncounterType .
https://healthterminologies.gov.au/fhir/ValueSet/encounter-type-1
DiagnosticReport.contained:encounter.serviceTypepreferredServiceType .
https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
DiagnosticReport.contained:encounter.priorityexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
DiagnosticReport.contained:encounter.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.contained:encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
DiagnosticReport.contained:encounter.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
DiagnosticReport.contained:encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
DiagnosticReport.contained:encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
from the FHIR Standard
DiagnosticReport.contained:encounter.hospitalization.dischargeDispositionextensibleSeparationMode . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)
https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1
DiagnosticReport.contained:encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
from the FHIR Standard
DiagnosticReport.contained:encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
DiagnosticReport.basedOn.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatusReportAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensibleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codepreferredEvaluationProcedure .
https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
DiagnosticReport.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.performer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.result.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.conclusionCodepreferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
DiagnosticReport.presentedForm.contentTyperequiredFixed Value: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DiagnosticReport.presentedForm.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
au-core-dir-01errorDiagnosticReportThe report shall at least have a result or a presentedForm
: result.exists() or presentedForm.exists()
au-core-dir-04errorDiagnosticReport.effective[x], DiagnosticReport.effective[x]:effectiveDateTimeDate shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUCoreDiagnosticReport

Summary

Mandatory: 3 elements(5 nested mandatory elements)
Must-Support: 7 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.contained
  • 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]

 

Other representations of profile: CSV, Excel, Schematron