AlternateIdentification (CDA Class) - Clinical Document Architecture v2.0.1-sd

Clinical Document Architecture
2.0.1-sd - release

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.1-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions

Logical Model: AlternateIdentification (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/AlternateIdentification				Version: 2.0.1-sd
Active as of 2024-12-18				Computable Name: AlternateIdentification

The alternateIdentification extension provides additional information about an identifier found in the linked role. The extensions augment the id information in the linked role. The id in the alternateIdentification extension SHALL match an id in the linked role. The alternateIdentification provides additional information about a particular identifier, such as its type. As an extension it needs to be safe for implementers to ignore this additional information.

Usage:

Use this Logical Model Profile: IdentifiedBy (CDA Class)

Formal Views of Template Content

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

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

This structure is derived from Base

Name	Card.	Type	Description & Constraints
AlternateIdentification	1..1	Base	Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@classCode	1..1	cs	XML Namespace: urn:hl7-org:v3 Binding: CDARoleClass (required) Fixed Value: IDENT
id	1..1	II	XML Namespace: urn:hl7-org:v3
code	0..1	CD	XML Namespace: urn:hl7-org:v3
statusCode	0..1	CS	XML Namespace: urn:hl7-org:v3 Binding: ActStatus (required)
effectiveTime	0..1	IVL_TS	XML Namespace: urn:hl7-org:v3
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
AlternateIdentification.classCode	required	Fixed Value: IDENT `http://hl7.org/cda/stds/core/ValueSet/CDARoleClass` from this IG
AlternateIdentification.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

Name	Card.	Type	Description & Constraints
AlternateIdentification	1..1	Base	Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@classCode	1..1	cs	XML Namespace: urn:hl7-org:v3 Binding: CDARoleClass (required) Fixed Value: IDENT
id	1..1	II	XML Namespace: urn:hl7-org:v3
code	0..1	CD	XML Namespace: urn:hl7-org:v3
statusCode	0..1	CS	XML Namespace: urn:hl7-org:v3 Binding: ActStatus (required)
effectiveTime	0..1	IVL_TS	XML Namespace: urn:hl7-org:v3
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AlternateIdentification.classCode	required	Fixed Value: IDENT `http://hl7.org/cda/stds/core/ValueSet/CDARoleClass` from this IG
AlternateIdentification.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

Name	Card.	Type	Description & Constraints
AlternateIdentification	1..1	Base	Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@classCode	1..1	cs	XML Namespace: urn:hl7-org:v3 Binding: CDARoleClass (required) Fixed Value: IDENT
id	1..1	II	XML Namespace: urn:hl7-org:v3
code	0..1	CD	XML Namespace: urn:hl7-org:v3
statusCode	0..1	CS	XML Namespace: urn:hl7-org:v3 Binding: ActStatus (required)
effectiveTime	0..1	IVL_TS	XML Namespace: urn:hl7-org:v3
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AlternateIdentification.classCode	required	Fixed Value: IDENT `http://hl7.org/cda/stds/core/ValueSet/CDARoleClass` from this IG
AlternateIdentification.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

This structure is derived from Base

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 Base

Name	Card.	Type	Description & Constraints
AlternateIdentification	1..1	Base	Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@classCode	1..1	cs	XML Namespace: urn:hl7-org:v3 Binding: CDARoleClass (required) Fixed Value: IDENT
id	1..1	II	XML Namespace: urn:hl7-org:v3
code	0..1	CD	XML Namespace: urn:hl7-org:v3
statusCode	0..1	CS	XML Namespace: urn:hl7-org:v3 Binding: ActStatus (required)
effectiveTime	0..1	IVL_TS	XML Namespace: urn:hl7-org:v3
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
AlternateIdentification.classCode	required	Fixed Value: IDENT `http://hl7.org/cda/stds/core/ValueSet/CDARoleClass` from this IG
AlternateIdentification.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

Key Elements View

Name	Card.	Type	Description & Constraints
AlternateIdentification	1..1	Base	Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@classCode	1..1	cs	XML Namespace: urn:hl7-org:v3 Binding: CDARoleClass (required) Fixed Value: IDENT
id	1..1	II	XML Namespace: urn:hl7-org:v3
code	0..1	CD	XML Namespace: urn:hl7-org:v3
statusCode	0..1	CS	XML Namespace: urn:hl7-org:v3 Binding: ActStatus (required)
effectiveTime	0..1	IVL_TS	XML Namespace: urn:hl7-org:v3
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AlternateIdentification.classCode	required	Fixed Value: IDENT `http://hl7.org/cda/stds/core/ValueSet/CDARoleClass` from this IG
AlternateIdentification.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

Snapshot View

Name	Card.	Type	Description & Constraints
AlternateIdentification	1..1	Base	Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@classCode	1..1	cs	XML Namespace: urn:hl7-org:v3 Binding: CDARoleClass (required) Fixed Value: IDENT
id	1..1	II	XML Namespace: urn:hl7-org:v3
code	0..1	CD	XML Namespace: urn:hl7-org:v3
statusCode	0..1	CS	XML Namespace: urn:hl7-org:v3 Binding: ActStatus (required)
effectiveTime	0..1	IVL_TS	XML Namespace: urn:hl7-org:v3
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AlternateIdentification.classCode	required	Fixed Value: IDENT `http://hl7.org/cda/stds/core/ValueSet/CDARoleClass` from this IG
AlternateIdentification.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

This structure is derived from Base

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

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1-sd based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents | QA Report | Version History external | | Propose a change