Complex
Primitive
ActivityDefinition
CapabilityStatement
CodeSystem
Composition
ConceptMap
Encounter
Library
List
Measure
MessageHeader
Observation
Patient
PlanDefinition
Questionnaire
Resource
ServiceDefinition
StructureDefinition
StructureMap
ValueSet
default
Base StructureDefinition for RelatedArtifact Type
RelatedArtifact
Path
RelatedArtifact
Id
RelatedArtifact
Cardinality
0 - *
Definition
Related artifacts such as additional documentation, justification, or bibliographic references.
Comment
Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ele-1
type
documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Path
RelatedArtifact.type
Id
RelatedArtifact.type
Type
Cardinality
1 - 1
Definition
The type of relationship to the related artifact.
Comment
Path
RelatedArtifact.display
Id
RelatedArtifact.display
Type
Cardinality
0 - 1
Definition
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Comment
Path
RelatedArtifact.citation
Id
RelatedArtifact.citation
Type
Cardinality
0 - 1
Definition
A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Comment
Additional structured information about citations should be captured as extensions.
Path
RelatedArtifact.url
Id
RelatedArtifact.url
Type
Cardinality
0 - 1
Definition
A url for the artifact that can be followed to access the actual content.
Comment
If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).
Path
RelatedArtifact.document
Id
RelatedArtifact.document
Type
Cardinality
0 - 1
Definition
The document being referenced, represented as an attachment. This is exclusive with the resource element.
Comment
Path
RelatedArtifact.document.Attachment.contentType
Id
Attachment.contentType
Type
Cardinality
0 - 1
Definition
Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
Comment
Requirements
Processors of the data need to be able to know how to interpret the data.
Path
RelatedArtifact.document.Attachment.data
Id
Attachment.data
Type
Cardinality
0 - 1
Definition
The actual data of the attachment - a sequence of bytes. In XML, represented using base64.
Comment
The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
Requirements
The data needs to able to be transmitted inline.
Path
RelatedArtifact.document.Attachment.url
Id
Attachment.url
Type
Cardinality
0 - 1
Definition
An alternative location where the data can be accessed.
Comment
If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
Requirements
The data needs to be transmitted by reference.
Path
RelatedArtifact.document.Attachment.size
Id
Attachment.size
Type
Cardinality
0 - 1
Definition
The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
Comment
The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
Requirements
Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
Path
RelatedArtifact.document.Attachment.hash
Id
Attachment.hash
Type
Cardinality
0 - 1
Definition
The calculated hash of the data using SHA-1. Represented using base64.
Comment
The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded.
Requirements
Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.
Path
RelatedArtifact.document.Attachment.title
Id
Attachment.title
Type
Cardinality
0 - 1
Definition
A label or set of text to display in place of the data.
Comment
Requirements
Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
Path
RelatedArtifact.document.Attachment.creation
Id
Attachment.creation
Type
Cardinality
0 - 1
Definition
The date that the attachment was first created.
Comment
Requirements
This is often tracked as an integrity issue for use of the attachment.
Path
RelatedArtifact.resource
Id
RelatedArtifact.resource
Type
Cardinality
0 - 1
Definition
The related resource, such as a library, value set, profile, or other knowledge resource.
Comment
If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.
Path
RelatedArtifact.resource.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
RelatedArtifact.resource.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
RelatedArtifact.resource.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
RelatedArtifact.resource.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
RelatedArtifact.resource.Reference.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
RelatedArtifact.resource.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
RelatedArtifact.resource.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
RelatedArtifact.resource.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
RelatedArtifact.resource.Reference.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Condition
per-1
Path
RelatedArtifact.resource.Reference.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
Condition
per-1
Path
RelatedArtifact.resource.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
RelatedArtifact.resource.Reference.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
RelatedArtifact.resource.Reference.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
RelatedArtifact.resource.Reference.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Path
RelatedArtifact.resource.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.