Summary
Diagnostics
Care Provision
Request & Response
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Documents
Terminology
Definitional Artifacts
Evidence-Based Medicine
Quality Reporting & Testing
Medication Definition
Public Health & Research
Complex
Primitive
ActivityDefinition
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
Encounter
Group
Library
List
Measure
MedicinalProduct
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
StructureDefinition
StructureMap
ValueSet
default
Base StructureDefinition for RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.
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
Binding
Strength
required
Description
The type of relationship to the related artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
RelatedArtifact.label
Id
RelatedArtifact.label
Type
Cardinality
0 - 1
Definition
A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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.
Binding
Strength
required
Description
The mime type of an attachment. Any valid mime type is allowed.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
RelatedArtifact.document.Attachment.data
Id
Attachment.data
Type
Cardinality
0 - 1
Definition
The actual data of the attachment - a sequence of bytes, base64 encoded.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
RelatedArtifact.document.Attachment.url
Id
Attachment.url
Type
Cardinality
0 - 1
Definition
A 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.
Requirements
Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children