This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
A clinical document written by the nominated provider, which contains key pieces of information about an individual’s health status and is useful to a wide range of providers in assessing individuals and delivering care. (PCEHR Concept of Operations document).
This model specifies the clinical data elements to be captured in the exchange of Shared Health Summary documents and the constraints that should be applied. Its scope is aligned to the document Concept of Operations: Relating to the introduction of a Personally Controlled Electronic Health Record System .
This is not a guide to implementing any specific messaging standard.
This specification is not to be used as a guide to presentation (or rendering) of the data. It contains no information as to how the data described by it should be displayed and no such information should be inferred.
Structure
Name | Flags | Card. | Type | Description & Constraints | Implemented As |
---|---|---|---|---|---|
SharedHealthSummary | Logical | Shared Health Summary | for src make thing as tgt = create(Composition), tgt.code = concept("LOINC", "60591-5") | ||
subjectofCare | 1..1 | Reference(Patient) | Subject of Care | for src.subjectofCare as x make tgt.subject = x | |
documentAuthor | 1..1 | Reference(Patient | Practitioner | RelatedPerson | Device) | Document Author | for src.documentAuthor as x make tgt.author = x for src.documentAuthor as xa make tgt.attestor as y = x, y.party = xa | |
documentType | 1..1 | Identifier | Document Type | for srcdocumentType make tgt.identifier then by type | |
dateTimeAttested | 1..1 | dateTime | DateTime Attested | for src.dateTimeAttested as x make tgt.date = x | |
adverseReactions | 1..1 | Element | Adverse Reactions | for src.adverseReactions as ar make tgt.section as sct1, sct1.title = "Adverse Reactions", sct1.code= concept("nehta-sct" : "101.20113") | |
exclusionStatementAdverseReactions | 0..1 | Element | Exclusion Statement - Adverse Reactions | for ar.exclusionStatementAdverseReactions as arex then by vars | |
globalStatement | 1..1 | CodeableConcept | Global Statement GlobalStatementValues (Required) | for arex as x make sct1.emptyReason = x | |
adverseReaction | 0..* | Element | Adverse Reaction | for ar.adverseReasion make ai as ai = create("AllergyIntolerance"), sct1.entry = pointer(ai) | |
substanceAgent | 1..1 | CodeableConcept | Substance/Agent SubstanceAgentValues (Preferred) | for ai.substanceAgent as x make ai.substance = x | |
event | 0..1 | Element | Reaction Event | for ai.event as ev make ai.reaction as air then by vars | |
manifestation | 1..* | CodeableConcept | Manifestation ClinicalManifestationValues (Preferred) | for ev.manifestation as x make air.manifestation = x | |
reactionType | 0..1 | CodeableConcept | Reaction Type | for ev.reactionType as x make ai.type as x {only-one} | |
medicationOrders | 1..1 | Element | Medication Orders | for src.medicationOrders as mo make tgt.section as sct2, sct2.title = "Medication Orders", sct2.code= concept("nehta-sct" : "101.16146") | |
exclusionStatementMedications | 0..1 | Element | Exclusion Statement - Medications | for mo.exclusionStatementMedications as moex then by vars | |
globalStatement | 1..1 | CodeableConcept | Global Statement GlobalStatementValues (Required) | for moex as x make sct2.emptyReason = x | |
medicationInstruction | 0..* | Element | Medication Instruction | for mo.medicationInstruction as moi make ms as ms = create("MedicationStatement"), sct2.entry = pointer(ms) | |
therapeuticGoodIdentification | 1..1 | CodeableConcept | Therapeutic Good Identification MedicinesTerminology (Preferred) | for moi.therapeuticGoodIdentification as x make ms.medicationCodeableConcept = x | |
directions | 1..1 | string | Directions | for moi.directions as moid make ms.dosage as msd, msd.text = moid | |
clinicalIndication | 0..1 | string | Clinical Indication | for moi.clinicalIndication as moic make ms.reasonForUseCodeableConcept as ru, ru.text = moic | |
comment | 0..1 | string | Medication Instruction Comment | for moi.comment as x make ms.note = x | |
medicalHistory | 1..1 | Element | Medical History | for src.medicalHistory as mh make tgt.section as sct3, sct3.title = "Medical History", sct3.code= concept("nehta-sct" : "101.16117") | |
problemDiagnosis | 0..* | Element | Problem/Diagnosis | for mh.problemDiagnosis as pd make cnd as cnd = create("Condition"), sct3.entry = pointer(cnd) | |
identification | 1..1 | CodeableConcept | Problem/Diagnosis Identification | for pd.identitification as x make cnd.code = x | |
dateofOnset | 0..1 | dateTime | Date of Onset | for pd.dateOfOnset as x make cnd.onsetDateTime = x | |
dateofResolutionRemission | 0..1 | dateTime | Date of Resolution/Remission | for pd.dateOfResolutionRemission as x make cnd.abatementDate = x | |
comment | 0..1 | string | Problem/Diagnosis Comment | for pd.comment as x make cnd.notes = x | |
exclusionStatementProblemsandDiagnoses | 0..1 | Element | Exclusion Statement - Problems and Diagnoses | for pd.exclusionStatementProblemsandDiagnoses as pdex then by vars | |
globalStatement | 1..1 | CodeableConcept | Global Statement GlobalStatementValues (Required) | for pdex as x make sct3.emptyReason = x | |
procedure | 0..* | Element | Procedure | for mh.procedure as pr make cndp as cndp = create("Condition"), sct3.entry = pointer(cndp) | |
name | 1..1 | CodeableConcept | Procedure Name | for pd.name as x make cndp.code = x | |
comment | 0..1 | string | Procedure Comment | for pd.comment as x make cndp.notes = x | |
dateTime | 1..1 | Period | Procedure DateTime | for pr.dateTime as x make cndp.onsetDateTime = x | |
exclusionStatementProcedures | 0..1 | Element | Exclusion Statement - Procedures | for mh.exclusionStatementProcedures as prex then by vars | |
globalStatement | 1..1 | CodeableConcept | Global Statement GlobalStatementValues (Required) | for prex as x make sct3.emptyReason = x | |
uncategorisedMedicalHistoryItem | 0..* | Element | Uncategorised Medical History Item | for mh.uncategorisedMedicalHistoryItem as item make cndi as cndp = create("Condition"), sct3.entry = pointer(cndi) then by vars | |
description | 1..1 | string | Medical History Item Description | for item.description as x make cndi.code as y, y.text = x | |
timeInterval | 0..1 | Period | Medical History Item TimeInterval | for item.timeInterval as ti then by vars for ti.start as x make cndi.onsetDateTime = x for ti.end as x make cndi.abatementDate = x | |
comment | 0..1 | string | Medical History Item Comment | for item.comment as x make cndi.notes = x | |
immunisations | 1..1 | Element | Immunisations | for src.immunizations as imm make tgt.section as sct4, sct4.title = "Immunization", sct4.code= concept("nehta-sct", "101.16117) | |
medicationAction | 0..* | Element | Medication Action | for imm.medicationAction as ima make im as im = create("Immunization"), sct4.entry = pointer(im) | |
therapeuticGoodIdentification | 1..1 | CodeableConcept | Therapeutic Good Identification MedicinesTerminology (Preferred) | for ima.therapeuticGoodIdentification as x make im.vaccineType = x | |
sequenceNumber | 0..1 | integer | Sequence Number | for ima.sequenceNumber as x make im.vaccinationProtocol as vp, vp.doseSequence = x | |
dateTime | 1..1 | dateTime | Medication Action DateTime | for ima.dateTime as x make imm.date = x | |
exclusionStatementMedications | 0..1 | Element | Exclusion Statement - Medications | for imm.exclusionStatementMedications as imex then by vars | |
globalStatement | 1..1 | CodeableConcept | Global Statement GlobalStatementValues (Required) | for imex as x make sct4.emptyReason = x | |
Documentation for this format |
UML Diagram
Structure
Name | Flags | Card. | Type | Description & Constraints | Implemented As |
---|---|---|---|---|---|
SharedHealthSummary | Logical | Shared Health Summary | for src make thing as tgt = create(Composition), tgt.code = concept("LOINC", "60591-5") | ||
subjectofCare | 1..1 | Reference(Patient) | Subject of Care | for src.subjectofCare as x make tgt.subject = x | |
documentAuthor | 1..1 | Reference(Patient | Practitioner | RelatedPerson | Device) | Document Author | for src.documentAuthor as x make tgt.author = x for src.documentAuthor as xa make tgt.attestor as y = x, y.party = xa | |
documentType | 1..1 | Identifier | Document Type | for srcdocumentType make tgt.identifier then by type | |
dateTimeAttested | 1..1 | dateTime | DateTime Attested | for src.dateTimeAttested as x make tgt.date = x | |
adverseReactions | 1..1 | Element | Adverse Reactions | for src.adverseReactions as ar make tgt.section as sct1, sct1.title = "Adverse Reactions", sct1.code= concept("nehta-sct" : "101.20113") | |
exclusionStatementAdverseReactions | 0..1 | Element | Exclusion Statement - Adverse Reactions | for ar.exclusionStatementAdverseReactions as arex then by vars | |
globalStatement | 1..1 | CodeableConcept | Global Statement GlobalStatementValues (Required) | for arex as x make sct1.emptyReason = x | |
adverseReaction | 0..* | Element | Adverse Reaction | for ar.adverseReasion make ai as ai = create("AllergyIntolerance"), sct1.entry = pointer(ai) | |
substanceAgent | 1..1 | CodeableConcept | Substance/Agent SubstanceAgentValues (Preferred) | for ai.substanceAgent as x make ai.substance = x | |
event | 0..1 | Element | Reaction Event | for ai.event as ev make ai.reaction as air then by vars | |
manifestation | 1..* | CodeableConcept | Manifestation ClinicalManifestationValues (Preferred) | for ev.manifestation as x make air.manifestation = x | |
reactionType | 0..1 | CodeableConcept | Reaction Type | for ev.reactionType as x make ai.type as x {only-one} | |
medicationOrders | 1..1 | Element | Medication Orders | for src.medicationOrders as mo make tgt.section as sct2, sct2.title = "Medication Orders", sct2.code= concept("nehta-sct" : "101.16146") | |
exclusionStatementMedications | 0..1 | Element | Exclusion Statement - Medications | for mo.exclusionStatementMedications as moex then by vars | |
globalStatement | 1..1 | CodeableConcept | Global Statement GlobalStatementValues (Required) | for moex as x make sct2.emptyReason = x | |
medicationInstruction | 0..* | Element | Medication Instruction | for mo.medicationInstruction as moi make ms as ms = create("MedicationStatement"), sct2.entry = pointer(ms) | |
therapeuticGoodIdentification | 1..1 | CodeableConcept | Therapeutic Good Identification MedicinesTerminology (Preferred) | for moi.therapeuticGoodIdentification as x make ms.medicationCodeableConcept = x | |
directions | 1..1 | string | Directions | for moi.directions as moid make ms.dosage as msd, msd.text = moid | |
clinicalIndication | 0..1 | string | Clinical Indication | for moi.clinicalIndication as moic make ms.reasonForUseCodeableConcept as ru, ru.text = moic | |
comment | 0..1 | string | Medication Instruction Comment | for moi.comment as x make ms.note = x | |
medicalHistory | 1..1 | Element | Medical History | for src.medicalHistory as mh make tgt.section as sct3, sct3.title = "Medical History", sct3.code= concept("nehta-sct" : "101.16117") | |
problemDiagnosis | 0..* | Element | Problem/Diagnosis | for mh.problemDiagnosis as pd make cnd as cnd = create("Condition"), sct3.entry = pointer(cnd) | |
identification | 1..1 | CodeableConcept | Problem/Diagnosis Identification | for pd.identitification as x make cnd.code = x | |
dateofOnset | 0..1 | dateTime | Date of Onset | for pd.dateOfOnset as x make cnd.onsetDateTime = x | |
dateofResolutionRemission | 0..1 | dateTime | Date of Resolution/Remission | for pd.dateOfResolutionRemission as x make cnd.abatementDate = x | |
comment | 0..1 | string | Problem/Diagnosis Comment | for pd.comment as x make cnd.notes = x | |
exclusionStatementProblemsandDiagnoses | 0..1 | Element | Exclusion Statement - Problems and Diagnoses | for pd.exclusionStatementProblemsandDiagnoses as pdex then by vars | |
globalStatement | 1..1 | CodeableConcept | Global Statement GlobalStatementValues (Required) | for pdex as x make sct3.emptyReason = x | |
procedure | 0..* | Element | Procedure | for mh.procedure as pr make cndp as cndp = create("Condition"), sct3.entry = pointer(cndp) | |
name | 1..1 | CodeableConcept | Procedure Name | for pd.name as x make cndp.code = x | |
comment | 0..1 | string | Procedure Comment | for pd.comment as x make cndp.notes = x | |
dateTime | 1..1 | Period | Procedure DateTime | for pr.dateTime as x make cndp.onsetDateTime = x | |
exclusionStatementProcedures | 0..1 | Element | Exclusion Statement - Procedures | for mh.exclusionStatementProcedures as prex then by vars | |
globalStatement | 1..1 | CodeableConcept | Global Statement GlobalStatementValues (Required) | for prex as x make sct3.emptyReason = x | |
uncategorisedMedicalHistoryItem | 0..* | Element | Uncategorised Medical History Item | for mh.uncategorisedMedicalHistoryItem as item make cndi as cndp = create("Condition"), sct3.entry = pointer(cndi) then by vars | |
description | 1..1 | string | Medical History Item Description | for item.description as x make cndi.code as y, y.text = x | |
timeInterval | 0..1 | Period | Medical History Item TimeInterval | for item.timeInterval as ti then by vars for ti.start as x make cndi.onsetDateTime = x for ti.end as x make cndi.abatementDate = x | |
comment | 0..1 | string | Medical History Item Comment | for item.comment as x make cndi.notes = x | |
immunisations | 1..1 | Element | Immunisations | for src.immunizations as imm make tgt.section as sct4, sct4.title = "Immunization", sct4.code= concept("nehta-sct", "101.16117) | |
medicationAction | 0..* | Element | Medication Action | for imm.medicationAction as ima make im as im = create("Immunization"), sct4.entry = pointer(im) | |
therapeuticGoodIdentification | 1..1 | CodeableConcept | Therapeutic Good Identification MedicinesTerminology (Preferred) | for ima.therapeuticGoodIdentification as x make im.vaccineType = x | |
sequenceNumber | 0..1 | integer | Sequence Number | for ima.sequenceNumber as x make im.vaccinationProtocol as vp, vp.doseSequence = x | |
dateTime | 1..1 | dateTime | Medication Action DateTime | for ima.dateTime as x make imm.date = x | |
exclusionStatementMedications | 0..1 | Element | Exclusion Statement - Medications | for imm.exclusionStatementMedications as imex then by vars | |
globalStatement | 1..1 | CodeableConcept | Global Statement GlobalStatementValues (Required) | for imex as x make sct4.emptyReason = x | |
Documentation for this format |
Path | Definition | Type | Reference |
---|---|---|---|
SharedHealthSummary.adverseReactions.exclusionStatementAdverseReactions.globalStatement SharedHealthSummary.medicationOrders.exclusionStatementMedications.globalStatement SharedHealthSummary.medicalHistory.exclusionStatementProblemsandDiagnoses.globalStatement SharedHealthSummary.medicalHistory.exclusionStatementProcedures.globalStatement SharedHealthSummary.immunisations.exclusionStatementMedications.globalStatement | The set of values for the global statements about the exclusion. | Required | GlobalStatementValues |
SharedHealthSummary.adverseReactions.adverseReaction.substanceAgent | The set of values for the agent or substance causing the adverse reaction experienced by the subject of care. | Preferred | SubstanceAgentValues |
SharedHealthSummary.adverseReactions.adverseReaction.event.manifestation | The set of values for recording clinical manifestation of an adverse reaction. | Preferred | ClinicalManifestationValues |
SharedHealthSummary.adverseReactions.adverseReaction.event.reactionType | The set of values for the type of adverse reaction. | Unknown | No details provided yet |
SharedHealthSummary.medicationOrders.medicationInstruction.therapeuticGoodIdentification SharedHealthSummary.immunisations.medicationAction.therapeuticGoodIdentification | A set of values used to refer to medicines and other therapeutic goods. | Preferred | MedicinesTerminology |
SharedHealthSummary.medicalHistory.problemDiagnosis.identification | The Problem/Diagnosis reference set provides terminology to support the recording of a subject of care problem or diagnosis for medical records within Australia. | Unknown | No details provided yet |
SharedHealthSummary.medicalHistory.procedure.name | The Procedure foundation reference set provides the broadest possible terminology to support the recording of clinical interventions in Australian eHealth implementations. | Unknown | No details provided yet |
todo;