Clinical Document Architecture with Australian Schema

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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Data Type Profile: cs: Coded Simple Value

Coded data in its simplest form, consists of a code. The code system and code system version is fixed by the context in which the value occurs. 'cs' is used for coded attributes that have a single HL7-defined value set.

Usages:

• Use this Primitive Type Profile: AD: PostalAddress (V3 Data Type), ADXP: CharacterString (V3 Data Type), ANY: DataValue (V3 Data Type), Act (CDA Class)... Show 178 more, AlternateIdentification (CDA Class), AssignedAuthor (CDA Class), AssignedCustodian (CDA Class), AssignedEntity (CDA Class), AssociatedEntity (CDA Class), Authenticator (CDA Class), Author (CDA Class), AuthoringDevice (CDA Class), Authorization (CDA Class), Birthplace (CDA Class), CD: ConceptDescriptor (V3 Data Type), ClinicalDocument (CDA Class), Component (CDA Class), ComponentOf (CDA Class), Consent (CDA Class), Criterion (CDA Class), Custodian (CDA Class), CustodianOrganization (CDA Class), DataEnterer (CDA Class), Device (CDA Class), DocumentationOf (CDA Class), ED: EncapsulatedData (V3 Data Type), EN: EntityName (V3 Data Type), ENXP: Entity Name Part (V3 Data Type), EncompassingEncounter (CDA Class), Encounter (CDA Class), EncounterParticipant (CDA Class), Entity (CDA Class), Entry (CDA Class), EntryRelationship (CDA Class), ExternalAct (CDA Class), ExternalDocument (CDA Class), ExternalObservation (CDA Class), ExternalProcedure (CDA Class), Guardian (CDA Class), HealthCareFacility (CDA Class), IVL_INT: Interval (V3 Data Type), IVL_PQ: Interval (V3 Data Type), InFulfillmentOf (CDA Class), InFulfillmentOf1 (CDA Class), Informant (CDA Class), InformationRecipient (CDA Class), IntendedRecipient (CDA Class), LabeledDrug (CDA Class), LegalAuthenticator (CDA Class), MO: MonetaryAmount (V3 Data Type), MaintainedEntity (CDA Class), ManufacturedProduct (CDA Class), Material (CDA Class), NonXMLBody (CDA Class), Observation (CDA Class), ObservationMedia (CDA Class), ObservationRange (CDA Class), Order (CDA Class), Organization (CDA Class), OrganizationPartOf (CDA Class), Organizer (CDA Class), OrganizerComponent (CDA Class), PIVL_TS: PeriodicIntervalOfTime (V3 Data Type), PQ: PhysicalQuantity (V3 Data Type), ParentDocument (CDA Class), Participant1 (CDA Class), Participant2 (CDA Class), ParticipantRole (CDA Class), Patient (CDA Class), PatientRole (CDA Class), Performer1 (CDA Class), Performer2 (CDA Class), Person (CDA Class), Place (CDA Class), PlayingEntity (CDA Class), Agency extension PolicyOrAccount, Precondition (CDA Class), Precondition2 (CDA Class), PreconditionBase (CDA Class), Procedure (CDA Class) , RecordTarget (CDA Class), Reference (CDA Class), RegionOfInterest (CDA Class), RelatedDocument (CDA Class), RelatedEntity (CDA Class), RelatedSubject (CDA Class), SC: CharacterStringWithCode (V3 Data Type), ST: CharacterString (V3 Data Type), SXCM_TS: GeneralTimingSpecification (V3 Data Type), Section (CDA Class), ServiceEvent (CDA Class), Specimen (CDA Class), SpecimenRole (CDA Class), StructuredBody (CDA Class), Subject (CDA Class), SubjectPerson (CDA Class), SubstanceAdministration (CDA Class), Supply (CDA Class), TEL: TelecommunicationAddress (V3 Data Type), addr AD: PostalAddress (V3 Data Type), ADHA Extension asEmployment, ADHA extension asEntityIdentifier, ADHA extension asIngredient, ADHA extension asPersonalRelationship, ADHA extension asEmployment, ADHA extension asQualifiedEntity, ADHA extension SpecimenInContainer, ADHA extension assigningGeographicArea used in asEntityIdentifier, ADHA Act (CDA Class), ADHA AD: PostalAddress (V3 Data Type), ADHA AssignedAuthor (CDA Class), ADHA AssignedCustodian (CDA Class), ADHA AssignedEntity (CDA Class), ADHA AssociatedEntity (CDA Class), ADHA Author (CDA Class), ADHA AuthoringDevice (CDA Class), ADHA ClinicalDocument (CDA Class), ADHA Component (CDA Class), ADHA ComponentOf (CDA Class), ADHA Custodian (CDA Class), ADHA CustodianOrganization (CDA Class), ADHA Device (CDA Class), ADHA EncompassingEncounter (CDA Class), ADHA Encounter (CDA Class), ADHA EncounterParticipant (CDA Class), ADHA Entity (CDA Class), ADHA EN: EntityName (V3 Data Type), ADHA Entry (CDA Class), ADHA EntryRelationship (CDA Class), ADHA ExternalAct (CDA Class), ADHA ExternalDocument (CDA Class), ADHA HealthCareFacility (CDA Class), ADHA InFulfillmentOf (CDA Class), ADHA Informant (CDA Class), ADHA InformationRecipient (CDA Class), ADHA IntendedRecipient (CDA Class), ADHA LegalAuthenticator (CDA Class), ADHA ManufacturedProduct (CDA Class), ADHA Material (CDA Class), ADHA Observation (CDA Class), ADHA ObservationMedia (CDA Class), ADHA ObservationRange (CDA Class), ADHA Order (CDA Class), ADHA Organization (CDA Class), ADHA OrganizationPartOf (CDA Class), ADHA Organizer (CDA Class), ADHA OrganizerComponent (CDA Class), ADHA ParentDocument (CDA Class), ADHA Participant1 (CDA Class), ADHA Participant2 (CDA Class), ADHA ParticipantRole ADHA (CDA Class), ADHA Patient (CDA Class), ADHA PatientRole (CDA Class), ADHA Performer2 (CDA Class), ADHA Person (CDA Class), ADHA Place (CDA Class), ADHA PlayingEntity (CDA Class), ADHA Precondition (CDA Class), ADHA Procedure (CDA Class), ADHA RecordTarget (CDA Class) , ADHA Reference (CDA Class), ADHA RegionOfInterest (CDA Class), ADHA RelatedDocument (CDA Class), ADHA Section (CDA Class), ADHA Specimen (CDA Class), SpecimenRole (CDA Class), ADHA StructuredBody (CDA Class), ADHA SubstanceAdministration (CDA Class), ADHA Supply (CDA Class), ADHA TEL: TelecommunicationAddress (V3 Data Type), ADHA extension controlAct, Agency extension coverage, ADHA extension coverage2, ADHA extension entitlement, ADHA extension ingredientManufacturedMaterial, ADHA extension participant, ADHA extension personalRelationship, Agency extension policy, Agency extension subjectOf1, Agency extension subjectOf2, Agency extension substitutionPermission and ADHA extension TEL: TelecommunicationAddress (V3 Data Type)

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
code	C	0..*	code	Primitive Type code Constraints: cs-pattern
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
cs-pattern	error	code	cs attributes must not contain any whitespace : matches('^[^\\s]+$')
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

This structure is derived from code

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
code	C	0..*	code	Primitive Type code Constraints: cs-pattern
id		0..0
extension		0..0
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
cs-pattern	error	code	cs attributes must not contain any whitespace : matches('^[^\\s]+$')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
code	C	0..*	code	Primitive Type code Constraints: cs-pattern
value		0..1	code	Primitive value for code
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
cs-pattern	error	code	cs attributes must not contain any whitespace : matches('^[^\\s]+$')
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

This structure is derived from code

Summary

Prohibited: 2 elements

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
code	C	0..*	code	Primitive Type code Constraints: cs-pattern
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
cs-pattern	error	code	cs attributes must not contain any whitespace : matches('^[^\\s]+$')
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Differential View

This structure is derived from code

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
code	C	0..*	code	Primitive Type code Constraints: cs-pattern
id		0..0
extension		0..0
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
cs-pattern	error	code	cs attributes must not contain any whitespace : matches('^[^\\s]+$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
code	C	0..*	code	Primitive Type code Constraints: cs-pattern
value		0..1	code	Primitive value for code
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
cs-pattern	error	code	cs attributes must not contain any whitespace : matches('^[^\\s]+$')
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

This structure is derived from code

Summary

Prohibited: 2 elements

Maturity: 1

Other representations of profile: CSV, Excel, Schematron