ADHA Extension asEmployment - Clinical Document Architecture with Australian Schema v1.0.0

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: ADHA Extension asEmployment

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/asEmployment				Version: 1.0.0
Active as of 2024-12-18				Computable Name: asEmployment
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/.

A person's occupation and employer.

Usage:

Use this Logical Model Profile: ADHA Patient (CDA Class) and ADHA Person (CDA Class)

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
asEmployment	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent an employment of a person Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode	1..1	cs	Fixed Value: EMP
code	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a descriptor of the job or job role XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of an employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the class of a job XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobClassCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the basis of employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
employerOrganization	1..1	employerOrganization	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the individual's nominated participation XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
asEmployment		1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent an employment of a person 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	Fixed Value: EMP
code		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a descriptor of the job or job role XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime		0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of an employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobCode		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the class of a job XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobClassCode		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the basis of employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
employerOrganization		1..1	employerOrganization	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the individual's nominated participation XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
asEmployment.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
asEmployment.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	asEmployment.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Name	Flags	Card.	Type	Description & Constraints
asEmployment		1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent an employment of a person 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	Fixed Value: EMP
code		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a descriptor of the job or job role XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime		0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of an employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobCode		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the class of a job XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobClassCode		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the basis of employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
employerOrganization		1..1	employerOrganization	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the individual's nominated participation XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
asEmployment.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
asEmployment.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	asEmployment.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(2 nested mandatory elements)
Fixed: 1 element

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Differential View

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
asEmployment	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent an employment of a person Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode	1..1	cs	Fixed Value: EMP
code	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a descriptor of the job or job role XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of an employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the class of a job XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobClassCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the basis of employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
employerOrganization	1..1	employerOrganization	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the individual's nominated participation XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
asEmployment		1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent an employment of a person 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	Fixed Value: EMP
code		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a descriptor of the job or job role XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime		0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of an employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobCode		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the class of a job XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobClassCode		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the basis of employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
employerOrganization		1..1	employerOrganization	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the individual's nominated participation XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
asEmployment.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
asEmployment.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	asEmployment.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
asEmployment		1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent an employment of a person 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	Fixed Value: EMP
code		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a descriptor of the job or job role XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime		0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of an employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobCode		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the class of a job XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
jobClassCode		0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the basis of employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
employerOrganization		1..1	employerOrganization	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the individual's nominated participation XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
asEmployment.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
asEmployment.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	asEmployment.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(2 nested mandatory elements)
Fixed: 1 element

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Other representations of profile: CSV, Excel