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-Supply | Version: 1.0.0 | |||
Active as of 2024-12-18 | Computable Name: au-Supply | |||
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 Supply 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 |
---|---|---|---|---|
Supply | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Supply class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
@classCode | 1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
id | 0..* | II | ||
code | 0..1 | CD | Binding: v3 Code System ActCode (example) | |
text | 0..1 | ED | ||
statusCode | 0..1 | CS | Binding: ActStatus (required) | |
effectiveTime | 0..* | |||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
priorityCode | 0..* | CE | Binding: ActPriority (example) | |
repeatNumber | 0..1 | IVL_INT | ||
independentInd | 0..1 | BL | ||
quantity | 0..1 | PQ | ||
expectedUseTime | 0..1 | IVL_TS | ||
product | 0..1 | InfrastructureRoot | ||
@typeCode | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
manufacturedProduct | 1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | Australian-adapted Specimen class | |
performer | 0..* | Performer2 | Australian-adapted Performer class | |
author | 0..* | Author | Australian-adapted Author class | |
informant | 0..* | Informant | Australian-adapted Informant class | |
participant | 0..* | Participant2 | Australian-adapted Participant2 class | |
entryRelationship | 0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
reference | 0..* | Reference | Australian-adapted Reference class | |
precondition | 0..* | Precondition | Australian-adapted Precondition class | |
SubjectOf2 | 0..1 | subjectOf2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent SubjectOf2 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
coverage2 | 0..* | coverage2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent coverage2 for supply's entitlement XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
InFulfillmentOf | 0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Supply class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
@classCode | 1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
id | 0..* | II | ||
code | 0..1 | CD | Binding: v3 Code System ActCode (example) | |
text | 0..1 | ED | ||
statusCode | 0..1 | CS | Binding: ActStatus (required) | |
effectiveTime | 0..* | |||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
priorityCode | 0..* | CE | Binding: ActPriority (example) | |
repeatNumber | 0..1 | IVL_INT | ||
independentInd | 0..1 | BL | ||
quantity | 0..1 | PQ | ||
expectedUseTime | 0..1 | IVL_TS | ||
product | 0..1 | InfrastructureRoot | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
manufacturedProduct | 1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | Australian-adapted Specimen class | |
performer | 0..* | Performer2 | Australian-adapted Performer class | |
author | 0..* | Author | Australian-adapted Author class | |
informant | 0..* | Informant | Australian-adapted Informant class | |
participant | 0..* | Participant2 | Australian-adapted Participant2 class | |
entryRelationship | 0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
reference | 0..* | Reference | Australian-adapted Reference class | |
precondition | 0..* | Precondition | Australian-adapted Precondition class | |
SubjectOf2 | 0..1 | subjectOf2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent SubjectOf2 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
coverage2 | 0..* | coverage2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent coverage2 for supply's entitlement XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
InFulfillmentOf | 0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Supply.typeId, Supply.product.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Supply class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
@classCode | 1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
id | 0..* | II | ||
code | 0..1 | CD | Binding: v3 Code System ActCode (example) | |
text | 0..1 | ED | ||
statusCode | 0..1 | CS | Binding: ActStatus (required) | |
effectiveTime | 0..* | |||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
priorityCode | 0..* | CE | Binding: ActPriority (example) | |
repeatNumber | 0..1 | IVL_INT | ||
independentInd | 0..1 | BL | ||
quantity | 0..1 | PQ | ||
expectedUseTime | 0..1 | IVL_TS | ||
product | 0..1 | InfrastructureRoot | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
manufacturedProduct | 1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | Australian-adapted Specimen class | |
performer | 0..* | Performer2 | Australian-adapted Performer class | |
author | 0..* | Author | Australian-adapted Author class | |
informant | 0..* | Informant | Australian-adapted Informant class | |
participant | 0..* | Participant2 | Australian-adapted Participant2 class | |
entryRelationship | 0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
reference | 0..* | Reference | Australian-adapted Reference class | |
precondition | 0..* | Precondition | Australian-adapted Precondition class | |
SubjectOf2 | 0..1 | subjectOf2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent SubjectOf2 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
coverage2 | 0..* | coverage2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent coverage2 for supply's entitlement XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
InFulfillmentOf | 0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Supply.typeId, Supply.product.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(3 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from InfrastructureRoot
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Supply class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
@classCode | 1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
id | 0..* | II | ||
code | 0..1 | CD | Binding: v3 Code System ActCode (example) | |
text | 0..1 | ED | ||
statusCode | 0..1 | CS | Binding: ActStatus (required) | |
effectiveTime | 0..* | |||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
priorityCode | 0..* | CE | Binding: ActPriority (example) | |
repeatNumber | 0..1 | IVL_INT | ||
independentInd | 0..1 | BL | ||
quantity | 0..1 | PQ | ||
expectedUseTime | 0..1 | IVL_TS | ||
product | 0..1 | InfrastructureRoot | ||
@typeCode | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
manufacturedProduct | 1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | Australian-adapted Specimen class | |
performer | 0..* | Performer2 | Australian-adapted Performer class | |
author | 0..* | Author | Australian-adapted Author class | |
informant | 0..* | Informant | Australian-adapted Informant class | |
participant | 0..* | Participant2 | Australian-adapted Participant2 class | |
entryRelationship | 0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
reference | 0..* | Reference | Australian-adapted Reference class | |
precondition | 0..* | Precondition | Australian-adapted Precondition class | |
SubjectOf2 | 0..1 | subjectOf2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent SubjectOf2 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
coverage2 | 0..* | coverage2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent coverage2 for supply's entitlement XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
InFulfillmentOf | 0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Supply class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
@classCode | 1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
id | 0..* | II | ||
code | 0..1 | CD | Binding: v3 Code System ActCode (example) | |
text | 0..1 | ED | ||
statusCode | 0..1 | CS | Binding: ActStatus (required) | |
effectiveTime | 0..* | |||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
priorityCode | 0..* | CE | Binding: ActPriority (example) | |
repeatNumber | 0..1 | IVL_INT | ||
independentInd | 0..1 | BL | ||
quantity | 0..1 | PQ | ||
expectedUseTime | 0..1 | IVL_TS | ||
product | 0..1 | InfrastructureRoot | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
manufacturedProduct | 1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | Australian-adapted Specimen class | |
performer | 0..* | Performer2 | Australian-adapted Performer class | |
author | 0..* | Author | Australian-adapted Author class | |
informant | 0..* | Informant | Australian-adapted Informant class | |
participant | 0..* | Participant2 | Australian-adapted Participant2 class | |
entryRelationship | 0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
reference | 0..* | Reference | Australian-adapted Reference class | |
precondition | 0..* | Precondition | Australian-adapted Precondition class | |
SubjectOf2 | 0..1 | subjectOf2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent SubjectOf2 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
coverage2 | 0..* | coverage2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent coverage2 for supply's entitlement XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
InFulfillmentOf | 0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Supply.typeId, Supply.product.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Supply class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
@classCode | 1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) | |
id | 0..* | II | ||
code | 0..1 | CD | Binding: v3 Code System ActCode (example) | |
text | 0..1 | ED | ||
statusCode | 0..1 | CS | Binding: ActStatus (required) | |
effectiveTime | 0..* | |||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
priorityCode | 0..* | CE | Binding: ActPriority (example) | |
repeatNumber | 0..1 | IVL_INT | ||
independentInd | 0..1 | BL | ||
quantity | 0..1 | PQ | ||
expectedUseTime | 0..1 | IVL_TS | ||
product | 0..1 | InfrastructureRoot | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
manufacturedProduct | 1..1 | ManufacturedProduct | Australian-adapted ManufacturedProduct class | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | Australian-adapted Specimen class | |
performer | 0..* | Performer2 | Australian-adapted Performer class | |
author | 0..* | Author | Australian-adapted Author class | |
informant | 0..* | Informant | Australian-adapted Informant class | |
participant | 0..* | Participant2 | Australian-adapted Participant2 class | |
entryRelationship | 0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
reference | 0..* | Reference | Australian-adapted Reference class | |
precondition | 0..* | Precondition | Australian-adapted Precondition class | |
SubjectOf2 | 0..1 | subjectOf2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent SubjectOf2 XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
coverage2 | 0..* | coverage2 | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent coverage2 for supply's entitlement XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
InFulfillmentOf | 0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Supply.typeId, Supply.product.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(3 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures: