{
  "description": "This profile enhances the current RelatedArtifact data with the enhancements identified in FHIR R5",
  "_filename": "StructureDefinition-RelatedArtifact-uv-f4f.json",
  "package_name": "hl7.fhir.uv.fhir-for-fair",
  "date": "2021-12-05T00:01:34+00:00",
  "derivation": "constraint",
  "publisher": "Health Level Seven International - SOA Work Group",
  "fhirVersion": "4.1.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "World"
    } ]
  } ],
  "name": "RelatedArtifactF4F",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "RelatedArtifact",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "RelatedArtifact (FHIR for FAIR)",
  "package_version": "0.1.0",
  "snapshot": {
    "element": [ {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children unless an empty Parameters resource",
        "xpath": "@value|f:*|h:div|self::f:Parameters",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count()) or $this is Parameters"
      } ],
      "path": "RelatedArtifact",
      "min": 0,
      "definition": "Related artifacts such as additional documentation, justification, or bibliographic references.",
      "isModifier": false,
      "short": "Related artifacts for a knowledge resource",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "max": "*",
      "id": "RelatedArtifact",
      "condition": [ "ele-1" ],
      "comment": "Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "RelatedArtifact"
      }
    }, {
      "path": "RelatedArtifact.id",
      "min": 0,
      "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "isModifier": false,
      "short": "Unique id for inter-element referencing",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "http://hl7.org/fhirpath/System.String",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUri": "string"
        } ]
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "RelatedArtifact.id",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Element.id"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "RelatedArtifact.extension",
      "min": 0,
      "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.",
      "isModifier": false,
      "short": "Additional content defined by implementations",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "slicing": {
        "rules": "open",
        "description": "Extensions are always sliced by (at least) url",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      },
      "type": [ {
        "code": "Extension"
      } ],
      "alias": [ "extensions", "user content" ],
      "max": "*",
      "id": "RelatedArtifact.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.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "RelatedArtifact.extension",
      "min": 0,
      "definition": "This extension enanches the current RelatedArtifact data type with the classifier element as specified in R5",
      "isModifier": false,
      "short": "Classifier (RelatedArtifact)",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier" ]
      } ],
      "sliceName": "classifier",
      "max": "1",
      "id": "RelatedArtifact.extension:classifier",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "RelatedArtifact.extension",
      "min": 0,
      "definition": "This extension enanches the current RelatedArtifact data type allowing to reference FHIR resources",
      "isModifier": false,
      "short": "ResourceReference (RelatedArtifact)",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference" ]
      } ],
      "sliceName": "resourceReference",
      "max": "1",
      "id": "RelatedArtifact.extension:resourceReference",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "RelatedArtifact.type",
      "min": 1,
      "definition": "The type of relationship to the related artifact.",
      "isModifier": false,
      "short": "documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of",
      "type": [ {
        "code": "code"
      } ],
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/related-artifact-type|4.1.0",
        "extension": [ {
          "url": "http://hl7.org/fhir/build/StructureDefinition/definition",
          "valueString": "The type of relationship to the related artifact."
        }, {
          "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString": "RelatedArtifactType"
        } ]
      },
      "max": "1",
      "id": "RelatedArtifact.type",
      "base": {
        "max": "1",
        "min": 1,
        "path": "RelatedArtifact.type"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "RelatedArtifact.label",
      "min": 0,
      "definition": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.",
      "isModifier": false,
      "short": "Short label",
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "id": "RelatedArtifact.label",
      "base": {
        "max": "1",
        "min": 0,
        "path": "RelatedArtifact.label"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "RelatedArtifact.display",
      "min": 0,
      "definition": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.",
      "isModifier": false,
      "short": "Brief description of the related artifact",
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "id": "RelatedArtifact.display",
      "base": {
        "max": "1",
        "min": 0,
        "path": "RelatedArtifact.display"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "RelatedArtifact.citation",
      "min": 0,
      "definition": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.",
      "isModifier": false,
      "short": "Bibliographic citation for the artifact",
      "type": [ {
        "code": "markdown"
      } ],
      "max": "1",
      "id": "RelatedArtifact.citation",
      "comment": "Additional structured information about citations should be captured as extensions.",
      "base": {
        "max": "1",
        "min": 0,
        "path": "RelatedArtifact.citation"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "RelatedArtifact.url",
      "min": 0,
      "definition": "A url for the artifact that can be followed to access the actual content.",
      "isModifier": false,
      "short": "Where the artifact can be accessed",
      "type": [ {
        "code": "url"
      } ],
      "max": "1",
      "id": "RelatedArtifact.url",
      "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).",
      "base": {
        "max": "1",
        "min": 0,
        "path": "RelatedArtifact.url"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "RelatedArtifact.document",
      "min": 0,
      "definition": "The document being referenced, represented as an attachment. This is exclusive with the resource element.",
      "isModifier": false,
      "short": "What document is being referenced",
      "type": [ {
        "code": "Attachment"
      } ],
      "max": "1",
      "id": "RelatedArtifact.document",
      "base": {
        "max": "1",
        "min": 0,
        "path": "RelatedArtifact.document"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "RelatedArtifact.resource",
      "min": 0,
      "definition": "The related resource, such as a library, value set, profile, or other knowledge resource.",
      "isModifier": false,
      "short": "What resource is being referenced",
      "type": [ {
        "code": "canonical",
        "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
      } ],
      "max": "1",
      "id": "RelatedArtifact.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.",
      "base": {
        "max": "1",
        "min": 0,
        "path": "RelatedArtifact.resource"
      },
      "isSummary": true
    } ]
  },
  "status": "active",
  "id": "549b3edb-486d-4443-b614-dad46b40157b",
  "kind": "complex-type",
  "url": "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/RelatedArtifact-uv-f4f",
  "version": "0.1.0",
  "differential": {
    "element": [ {
      "id": "RelatedArtifact",
      "path": "RelatedArtifact"
    }, {
      "id": "RelatedArtifact.extension:classifier",
      "max": "1",
      "min": 0,
      "path": "RelatedArtifact.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier" ]
      } ],
      "sliceName": "classifier"
    }, {
      "id": "RelatedArtifact.extension:resourceReference",
      "max": "1",
      "min": 0,
      "path": "RelatedArtifact.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference" ]
      } ],
      "sliceName": "resourceReference"
    } ]
  },
  "contact": [ {
    "name": "Health Level Seven International - SOA Work Group",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/soa",
      "system": "url"
    } ]
  }, {
    "name": "HL7 SOA Work Group",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/soa",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedArtifact"
}