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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Reference | This is an abstract profile. A reference from one resource to another Constraints: ref-1, ref-2 |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ref-1 | error | Reference | SHALL 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-2 | error | Reference | At 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() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Reference | This is an abstract profile. A reference from one resource to another Constraints: ref-1, ref-2 |
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource |
![]() |
Path | Conformance | ValueSet | URI |
Reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ref-1 | error | Reference | SHALL 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-2 | error | Reference | At 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() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Reference | This is an abstract profile. A reference from one resource to another Constraints: ref-1, ref-2 |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ref-1 | error | Reference | SHALL 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-2 | error | Reference | At 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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
Reference | This is an abstract profile. | ||
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Reference | This is an abstract profile. A reference from one resource to another Constraints: ref-1, ref-2 |
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource |
![]() |
Path | Conformance | ValueSet | URI |
Reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ref-1 | error | Reference | SHALL 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-2 | error | Reference | At 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() |
Other representations of profile: CSV, Excel, Schematron