Datatypes
Class RelatedArtifact

"The RelatedArtifact structure defines resources related to a module such as previous and next versions of documents, documentation, citations, etc. Note that the name resource here is being used in a more general sense than the FHIR-specific Resource. The related resource may be a FHIR resource, or it may be another type of resource, represented using the Attachment data type." - HL7 FHIR, RelatedArtifact

Attributes
String citation citation

"A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format." - HL7 FHIR, RelatedArtifact.citation

String display display

"A brief description of the document or knowledge resource being referenced, suitable for display to a consumer." - HL7 FHIR, RelatedArtifact.display

Image document document

"The document being referenced, represented as an attachment. This is exclusive with the resource element." - HL7 FHIR, RelatedArtifact.document

«CS» Code kind kind

"The type of relationship to the related artifact." Possible values are: Documentation; Justification; Citation; Predecessor; Successor; Derived From; Depends On; Composed Of - HL7 FHIR, RelatedArtifact.type

String label label

"A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index." - HL7 FHIR, RelatedArtifact.label

«ANY» Any resource resource

"The related resource, such as a library, value set, profile, or other knowledge resource." - HL7 FHIR, RelatedArtifact.resource

String url url

"A url for the artifact that can be followed to access the actual content." - HL7 FHIR, RelatedArtifact.url


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameRelatedArtifact
Name Expression
NamespaceDatatypes
Owned Template Signature
OwnerDatatypes
Owning Template Parameter
PackageDatatypes
Qualified NameFHIM::Datatypes::RelatedArtifact
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 citation
Public String citation

"A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format." - HL7 FHIR, RelatedArtifact.citation

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassRelatedArtifact
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namecitation
Name Expression
NamespaceRelatedArtifact
Opposite
OwnerRelatedArtifact
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::RelatedArtifact::citation
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 display
Public String display

"A brief description of the document or knowledge resource being referenced, suitable for display to a consumer." - HL7 FHIR, RelatedArtifact.display

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassRelatedArtifact
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedisplay
Name Expression
NamespaceRelatedArtifact
Opposite
OwnerRelatedArtifact
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::RelatedArtifact::display
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 document
Public Image document

"The document being referenced, represented as an attachment. This is exclusive with the resource element." - HL7 FHIR, RelatedArtifact.document

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassRelatedArtifact
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedocument
Name Expression
NamespaceRelatedArtifact
Opposite
OwnerRelatedArtifact
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::RelatedArtifact::document
Stereotype
Template Parameter
TypeImage
Upper1
Upper Value(1)
VisibilityPublic


 kind
Public «CS» Code kind

"The type of relationship to the related artifact." Possible values are: Documentation; Justification; Citation; Predecessor; Successor; Derived From; Depends On; Composed Of - HL7 FHIR, RelatedArtifact.type

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassRelatedArtifact
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namekind
Name Expression
NamespaceRelatedArtifact
Opposite
OwnerRelatedArtifact
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::RelatedArtifact::kind
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 label
Public String label

"A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index." - HL7 FHIR, RelatedArtifact.label

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassRelatedArtifact
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namelabel
Name Expression
NamespaceRelatedArtifact
Opposite
OwnerRelatedArtifact
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::RelatedArtifact::label
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 resource
Public «ANY» Any resource

"The related resource, such as a library, value set, profile, or other knowledge resource." - HL7 FHIR, RelatedArtifact.resource

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassRelatedArtifact
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameresource
Name Expression
NamespaceRelatedArtifact
Opposite
OwnerRelatedArtifact
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::RelatedArtifact::resource
Stereotype
Template Parameter
Type«ANY» Any
Upper1
Upper Value(1)
VisibilityPublic


 url
Public String url

"A url for the artifact that can be followed to access the actual content." - HL7 FHIR, RelatedArtifact.url

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassRelatedArtifact
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameurl
Name Expression
NamespaceRelatedArtifact
Opposite
OwnerRelatedArtifact
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::RelatedArtifact::url
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic