Clinical Document Architecture with Australian Schema
1.0.0 - current
Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntryRelationship | Version: 1.0.0 | |||
| Active as of 2024-11-22 | Computable Name: EntryRelationship | |||
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
Australian adaptation of the HL7 International CDA EntryRelationship class.
This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EntryRelationship |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA EntryRelationship class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. |
  @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
 sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
  (Choice of one) |
1..1 | |||
  act |
0..1 | Act | Australian-adapted Act class | |
| encounter |
0..1 | Encounter | Australian-adapted Encounter class | |
| observation |
0..1 | Observation | Australian-adapted Observation class | |
| observationMedia |
0..1 | ObservationMedia | Australian-adapted ObservationMedia class | |
| organizer |
0..1 | Organizer | Australian-adapted Organizer class | |
| procedure |
0..1 | Procedure | Australian-adapted Procedure class | |
| regionOfInterest |
0..1 | RegionOfInterest | Australian-adapted SubstanceAdministration class | |
| substanceAdministration |
0..1 | SubstanceAdministration | Australian-adapted SubstanceAdministration class | |
 supply |
0..1 | Supply | Australian-adapted Supply class | |
 controlAct |
0..1 | controlAct | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent control act XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EntryRelationship |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA EntryRelationship class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| act |
0..1 | Act | Australian-adapted Act class | |
| encounter |
0..1 | Encounter | Australian-adapted Encounter class | |
| observation |
0..1 | Observation | Australian-adapted Observation class | |
| observationMedia |
0..1 | ObservationMedia | Australian-adapted ObservationMedia class | |
| organizer |
0..1 | Organizer | Australian-adapted Organizer class | |
| procedure |
0..1 | Procedure | Australian-adapted Procedure class | |
| regionOfInterest |
0..1 | RegionOfInterest | Australian-adapted SubstanceAdministration class | |
| substanceAdministration |
0..1 | SubstanceAdministration | Australian-adapted SubstanceAdministration class | |
| supply |
0..1 | Supply | Australian-adapted Supply class | |
| controlAct |
0..1 | controlAct | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent control act XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EntryRelationship |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA EntryRelationship class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| act |
0..1 | Act | Australian-adapted Act class | |
| encounter |
0..1 | Encounter | Australian-adapted Encounter class | |
| observation |
0..1 | Observation | Australian-adapted Observation class | |
| observationMedia |
0..1 | ObservationMedia | Australian-adapted ObservationMedia class | |
| organizer |
0..1 | Organizer | Australian-adapted Organizer class | |
| procedure |
0..1 | Procedure | Australian-adapted Procedure class | |
| regionOfInterest |
0..1 | RegionOfInterest | Australian-adapted SubstanceAdministration class | |
| substanceAdministration |
0..1 | SubstanceAdministration | Australian-adapted SubstanceAdministration class | |
| supply |
0..1 | Supply | Australian-adapted Supply class | |
| controlAct |
0..1 | controlAct | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent control act XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EntryRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| EntryRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
This structure is derived from InfrastructureRoot
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EntryRelationship |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA EntryRelationship class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| act |
0..1 | Act | Australian-adapted Act class | |
| encounter |
0..1 | Encounter | Australian-adapted Encounter class | |
| observation |
0..1 | Observation | Australian-adapted Observation class | |
| observationMedia |
0..1 | ObservationMedia | Australian-adapted ObservationMedia class | |
| organizer |
0..1 | Organizer | Australian-adapted Organizer class | |
| procedure |
0..1 | Procedure | Australian-adapted Procedure class | |
| regionOfInterest |
0..1 | RegionOfInterest | Australian-adapted SubstanceAdministration class | |
| substanceAdministration |
0..1 | SubstanceAdministration | Australian-adapted SubstanceAdministration class | |
| supply |
0..1 | Supply | Australian-adapted Supply class | |
| controlAct |
0..1 | controlAct | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent control act XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EntryRelationship |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA EntryRelationship class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| act |
0..1 | Act | Australian-adapted Act class | |
| encounter |
0..1 | Encounter | Australian-adapted Encounter class | |
| observation |
0..1 | Observation | Australian-adapted Observation class | |
| observationMedia |
0..1 | ObservationMedia | Australian-adapted ObservationMedia class | |
| organizer |
0..1 | Organizer | Australian-adapted Organizer class | |
| procedure |
0..1 | Procedure | Australian-adapted Procedure class | |
| regionOfInterest |
0..1 | RegionOfInterest | Australian-adapted SubstanceAdministration class | |
| substanceAdministration |
0..1 | SubstanceAdministration | Australian-adapted SubstanceAdministration class | |
| supply |
0..1 | Supply | Australian-adapted Supply class | |
| controlAct |
0..1 | controlAct | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent control act XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EntryRelationship |
C | 1..* | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA EntryRelationship class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| act |
0..1 | Act | Australian-adapted Act class | |
| encounter |
0..1 | Encounter | Australian-adapted Encounter class | |
| observation |
0..1 | Observation | Australian-adapted Observation class | |
| observationMedia |
0..1 | ObservationMedia | Australian-adapted ObservationMedia class | |
| organizer |
0..1 | Organizer | Australian-adapted Organizer class | |
| procedure |
0..1 | Procedure | Australian-adapted Procedure class | |
| regionOfInterest |
0..1 | RegionOfInterest | Australian-adapted SubstanceAdministration class | |
| substanceAdministration |
0..1 | SubstanceAdministration | Australian-adapted SubstanceAdministration class | |
| supply |
0..1 | Supply | Australian-adapted Supply class | |
| controlAct |
0..1 | controlAct | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent control act XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EntryRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| EntryRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
This structure is derived from InfrastructureRoot
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-11-22
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
