| Package | hl7.fhir.uv.fhir-for-fair |
| Type | StructureDefinition |
| Id | RelatedArtifact-uv-f4f |
| FHIR Version | R4B |
| Source | http://hl7.org/fhir/uv/fhir-for-fair/https://build.fhir.org/ig/HL7/fhir-for-fair/StructureDefinition-RelatedArtifact-uv-f4f.html |
| URL | http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/RelatedArtifact-uv-f4f |
| Version | 1.0.0 |
| Status | active |
| Date | 2024-01-05T17:42:10+00:00 |
| Name | RelatedArtifactF4F |
| Title | RelatedArtifact [FHIR for FAIR] |
| Realm | uv |
| Authority | hl7 |
| Description | This profile enhances the current RelatedArtifact data with the enhancements identified in FHIR R5 |
| Type | RelatedArtifact |
| Kind | complex-type |
| StructureDefinition | |
| Library-uv-f4f | Library [Study Level Medatata] |
| ResearchStudy-uv-f4f | ResearchStudy [Study Level Medatata] |
| library-relatedContent | Content as RelatedArtifact [Library] |
| StructureDefinition | |
| relatedArtifactClassifier | Classifier [RelatedArtifact] |
| relatedArtifactResourceReference | ResourceReference [RelatedArtifact] |
| relatedArtifactType | Type [RelatedArtifact] |
Note: links and images are rebased to the (stated) source
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedArtifact | RelatedArtifact | |||
  classifier | 0..1 | CodeableConcept | Classifier [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier | |
| resourceReference | 0..1 | Reference(Resource) | ResourceReference [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference | |
 relationshipType | 0..1 | CodeableConcept | Type [RelatedArtifact] URL: http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactType Binding: RelatedArtifactType [ValueSet] (extensible) | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "RelatedArtifact-uv-f4f",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/RelatedArtifact-uv-f4f",
"version": "1.0.0",
"name": "RelatedArtifactF4F",
"title": "RelatedArtifact [FHIR for FAIR]",
"status": "active",
"date": "2024-01-05T17:42:10+00:00",
"publisher": "Health Level Seven International - SOA Work Group",
"contact": [
{
"name": "Health Level Seven International - SOA Work Group",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/soa"
}
]
},
{
"name": "HL7 SOA Work Group",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/soa"
}
]
}
],
"description": "This profile enhances the current RelatedArtifact data with the enhancements identified in FHIR R5",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "4.3.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"type": "RelatedArtifact",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedArtifact",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "RelatedArtifact",
"path": "RelatedArtifact",
"short": "Related artifacts for a knowledge resource",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "RelatedArtifact",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "RelatedArtifact.id",
"path": "RelatedArtifact.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "RelatedArtifact.extension",
"path": "RelatedArtifact.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "RelatedArtifact.extension:classifier",
"path": "RelatedArtifact.extension",
"sliceName": "classifier",
"short": "Classifier [RelatedArtifact]",
"definition": "This extension enanches the current RelatedArtifact data type with the classifier element as specified in R5",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "RelatedArtifact.extension:resourceReference",
"path": "RelatedArtifact.extension",
"sliceName": "resourceReference",
"short": "ResourceReference [RelatedArtifact]",
"definition": "This extension enanches the current RelatedArtifact data type allowing to reference FHIR resources",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "RelatedArtifact.extension:relationshipType",
"path": "RelatedArtifact.extension",
"sliceName": "relationshipType",
"short": "Type [RelatedArtifact]",
"definition": "This extension enanches the current RelatedArtifact data type with extending the supported relationship types as specified in R5",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactType"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "RelatedArtifact.type",
"path": "RelatedArtifact.type",
"short": "documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of",
"definition": "The type of relationship to the related artifact.",
"min": 1,
"max": "1",
"base": {
"path": "RelatedArtifact.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/build/StructureDefinition/binding-definition",
"valueString": "The type of relationship to the related artifact."
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RelatedArtifactType"
}
],
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/related-artifact-type|4.3.0"
}
},
{
"id": "RelatedArtifact.label",
"path": "RelatedArtifact.label",
"short": "Short label",
"definition": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.",
"min": 0,
"max": "1",
"base": {
"path": "RelatedArtifact.label",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "RelatedArtifact.display",
"path": "RelatedArtifact.display",
"short": "Brief description of the related artifact",
"definition": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.",
"min": 0,
"max": "1",
"base": {
"path": "RelatedArtifact.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "RelatedArtifact.citation",
"path": "RelatedArtifact.citation",
"short": "Bibliographic citation for the artifact",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "RelatedArtifact.citation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "RelatedArtifact.url",
"path": "RelatedArtifact.url",
"short": "Where the artifact can be accessed",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "RelatedArtifact.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "url"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "RelatedArtifact.document",
"path": "RelatedArtifact.document",
"short": "What document is being referenced",
"definition": "The document being referenced, represented as an attachment. This is exclusive with the resource element.",
"min": 0,
"max": "1",
"base": {
"path": "RelatedArtifact.document",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Attachment"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "RelatedArtifact.resource",
"path": "RelatedArtifact.resource",
"short": "What resource is being referenced",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "RelatedArtifact.resource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
}
]
},
"differential": {
"element": [
{
"id": "RelatedArtifact.extension:classifier",
"path": "RelatedArtifact.extension",
"sliceName": "classifier",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier"
]
}
]
},
{
"id": "RelatedArtifact.extension:resourceReference",
"path": "RelatedArtifact.extension",
"sliceName": "resourceReference",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference"
]
}
]
},
{
"id": "RelatedArtifact.extension:relationshipType",
"path": "RelatedArtifact.extension",
"sliceName": "relationshipType",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactType"
]
}
]
}
]
}
}