Pharmaceutical Quality - Chemistry, Manufacturing and Controls (PQ-CMC) Submissions to FDA
2.0.0 - STU2 United States of America flag

This page is part of the Pharmaceutical Quality - Chemistry, Manufacturing and Controls (PQ-CMC) Submissions to FDA (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Data Type Profile: Literal Reference ( Abstract )

Official URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/literal-reference Version: 2.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: LiteralReference
Other Identifiers: OID:2.16.840.1.113883.4.642.40.36.42.63

An abstract profile to ensure the reference is always a literal reference. Used in conjunction with a rule set to ensure every reference is also bundled.

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference This is an abstract profile.
A reference from one resource to another
Constraints: ref-1, ref-2
... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ref-1errorReferenceSHALL have a contained resource if a local reference is provided
: reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2errorReferenceAt least one of reference, identifier and display SHALL be present (unless an extension is provided).
: reference.exists() or identifier.exists() or display.exists() or extension.exists()

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference Reference This is an abstract profile.
... reference S 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference This is an abstract profile.
A reference from one resource to another
Constraints: ref-1, ref-2
... id 0..1 id Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
... display ΣC 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorReferenceSHALL have a contained resource if a local reference is provided
: reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2errorReferenceAt least one of reference, identifier and display SHALL be present (unless an extension is provided).
: reference.exists() or identifier.exists() or display.exists() or extension.exists()

This structure is derived from Reference

Summary

Mandatory: 1 element
Must-Support: 1 element

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference This is an abstract profile.
A reference from one resource to another
Constraints: ref-1, ref-2
... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ref-1errorReferenceSHALL have a contained resource if a local reference is provided
: reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2errorReferenceAt least one of reference, identifier and display SHALL be present (unless an extension is provided).
: reference.exists() or identifier.exists() or display.exists() or extension.exists()

Differential View

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference Reference This is an abstract profile.
... reference S 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference This is an abstract profile.
A reference from one resource to another
Constraints: ref-1, ref-2
... id 0..1 id Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
... display ΣC 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorReferenceSHALL have a contained resource if a local reference is provided
: reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2errorReferenceAt least one of reference, identifier and display SHALL be present (unless an extension is provided).
: reference.exists() or identifier.exists() or display.exists() or extension.exists()

This structure is derived from Reference

Summary

Mandatory: 1 element
Must-Support: 1 element

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron