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

Logical Model: SpecimenRole (CDA Class)

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-SpecimenRole Version: 1.0.0
Active as of 2024-12-18 Computable Name: SpecimenRole

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 SpecimenRole 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:

Formal Views of Profile Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA SpecimenRole class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: RoleClassSpecimen (required)
Fixed Value: SPEC
... id 0..* II
... specimenPlayingEntity 0..1 PlayingEntity Australian-adapted PlayingEntity class

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
SpecimenRole.classCoderequiredFixed Value: SPEC
http://terminology.hl7.org/ValueSet/v3-RoleClassSpecimen
NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA SpecimenRole 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
... @classCode 0..1 cs Binding: RoleClassSpecimen (required)
Fixed Value: SPEC
... id 0..* II
... specimenPlayingEntity 0..1 PlayingEntity Australian-adapted PlayingEntity class

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SpecimenRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
SpecimenRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
SpecimenRole.classCoderequiredFixed Value: SPEC
http://terminology.hl7.org/ValueSet/v3-RoleClassSpecimen

Constraints

IdGradePath(s)DetailsRequirements
II-1errorSpecimenRole.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA SpecimenRole 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
... @classCode 0..1 cs Binding: RoleClassSpecimen (required)
Fixed Value: SPEC
... id 0..* II
... specimenPlayingEntity 0..1 PlayingEntity Australian-adapted PlayingEntity class

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SpecimenRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
SpecimenRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
SpecimenRole.classCoderequiredFixed Value: SPEC
http://terminology.hl7.org/ValueSet/v3-RoleClassSpecimen

Constraints

IdGradePath(s)DetailsRequirements
II-1errorSpecimenRole.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Fixed: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA SpecimenRole class
Instance of this type are validated by templateId
Logical Container: ADHA ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: RoleClassSpecimen (required)
Fixed Value: SPEC
... id 0..* II
... specimenPlayingEntity 0..1 PlayingEntity Australian-adapted PlayingEntity class

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
SpecimenRole.classCoderequiredFixed Value: SPEC
http://terminology.hl7.org/ValueSet/v3-RoleClassSpecimen

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA SpecimenRole 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
... @classCode 0..1 cs Binding: RoleClassSpecimen (required)
Fixed Value: SPEC
... id 0..* II
... specimenPlayingEntity 0..1 PlayingEntity Australian-adapted PlayingEntity class

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SpecimenRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
SpecimenRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
SpecimenRole.classCoderequiredFixed Value: SPEC
http://terminology.hl7.org/ValueSet/v3-RoleClassSpecimen

Constraints

IdGradePath(s)DetailsRequirements
II-1errorSpecimenRole.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Australian adaptation of the HL7 International CDA SpecimenRole 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
... @classCode 0..1 cs Binding: RoleClassSpecimen (required)
Fixed Value: SPEC
... id 0..* II
... specimenPlayingEntity 0..1 PlayingEntity Australian-adapted PlayingEntity class

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SpecimenRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
SpecimenRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
SpecimenRole.classCoderequiredFixed Value: SPEC
http://terminology.hl7.org/ValueSet/v3-RoleClassSpecimen

Constraints

IdGradePath(s)DetailsRequirements
II-1errorSpecimenRole.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Fixed: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel