http://hl7.org/fhir/StructureDefinition/Citation|5.0.0

The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
description: The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
derivation: specialization
name: Citation
type: Citation
elements:
  description: {isModifier: false, short: Natural language description of the citation, mustSupport: false, isSummary: false, index: 12}
  date: {isModifier: false, short: Date last changed, mustSupport: false, isSummary: true, index: 9}
  citedArtifact:
    isModifier: false
    short: The article or artifact being described
    mustSupport: false
    isSummary: false
    index: 38
    elements:
      dateAccessed: {isModifier: false, short: When the cited artifact was accessed, mustSupport: false, isSummary: true, index: 41}
      part:
        isModifier: false
        short: The component of the article or artifact
        mustSupport: false
        isSummary: false
        index: 59
        elements:
          type:
            isModifier: false
            short: The kind of component
            mustSupport: false
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/cited-artifact-part-type'}
            isSummary: false
            index: 60
          value: {isModifier: false, short: The specification of the component, mustSupport: false, isSummary: false, index: 61}
          baseCitation: {isModifier: false, short: The citation for the full article or artifact, mustSupport: false, isSummary: false, index: 62}
      abstract:
        isModifier: false
        short: Summary of the article or artifact
        mustSupport: false
        array: true
        isSummary: false
        index: 54
        elements:
          type:
            isModifier: false
            short: The kind of abstract
            mustSupport: false
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/cited-artifact-abstract-type'}
            isSummary: false
            index: 55
          language:
            isModifier: false
            short: Used to express the specific language
            mustSupport: false
            binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/languages'}
            isSummary: false
            index: 56
          text: {isModifier: false, short: Abstract content, mustSupport: false, isSummary: false, index: 57}
          copyright: {isModifier: false, short: Copyright notice for the abstract, mustSupport: false, isSummary: false, index: 58}
        required: [text]
      publicationForm:
        isModifier: false
        short: If multiple, used to represent alternative forms of the article that are not separate citations
        mustSupport: false
        array: true
        isSummary: false
        index: 72
        elements:
          issue: {isModifier: false, short: 'Issue, part or supplement of journal or other collection in which the article is published', mustSupport: false, isSummary: false, index: 81}
          lastPage: {isModifier: false, short: Used for isolated representation of last page, mustSupport: false, isSummary: false, index: 90}
          publicationDateSeason: {isModifier: false, short: Season in which the cited artifact was published, mustSupport: false, isSummary: false, index: 84}
          firstPage: {isModifier: false, short: Used for isolated representation of first page, mustSupport: false, isSummary: false, index: 89}
          accessionNumber: {isModifier: false, short: Entry number or identifier for inclusion in a database, mustSupport: false, isSummary: false, index: 87}
          publishedIn:
            isModifier: false
            short: The collection the cited article or artifact is published in
            mustSupport: false
            isSummary: false
            index: 73
            elements:
              type:
                isModifier: false
                short: Kind of container (e.g. Periodical, database, or book)
                mustSupport: false
                binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/published-in-type'}
                isSummary: false
                index: 74
              identifier: {isModifier: false, short: 'Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN', mustSupport: false, array: true, isSummary: false, index: 75}
              title: {isModifier: false, short: Name of the database or title of the book or journal, mustSupport: false, isSummary: false, index: 76}
              publisher: {isModifier: false, short: Name of or resource describing the publisher, mustSupport: false, isSummary: false, index: 77}
              publisherLocation: {isModifier: false, short: Geographic location of the publisher, mustSupport: false, isSummary: false, index: 78}
          copyright: {isModifier: false, short: Copyright notice for the full article or artifact, mustSupport: false, isSummary: false, index: 92}
          volume: {isModifier: false, short: Volume number of journal or other collection in which the article is published, mustSupport: false, isSummary: false, index: 80}
          citedMedium:
            isModifier: false
            short: Internet or Print
            mustSupport: false
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/cited-medium'}
            isSummary: false
            index: 79
          lastRevisionDate: {isModifier: false, short: The date the article was last revised or updated in the database, mustSupport: false, isSummary: false, index: 85}
          language:
            isModifier: false
            short: Language(s) in which this form of the article is published
            mustSupport: false
            array: true
            binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/languages'}
            isSummary: false
            index: 86
          pageString: {isModifier: false, short: Used for full display of pagination, mustSupport: false, isSummary: false, index: 88}
          articleDate: {isModifier: false, short: 'The date the article was added to the database, or the date the article was released', mustSupport: false, isSummary: false, index: 82}
          pageCount: {isModifier: false, short: Number of pages or screens, mustSupport: false, isSummary: false, index: 91}
          publicationDateText: {isModifier: false, short: Text representation of the date on which the issue of the cited artifact was published, mustSupport: false, isSummary: false, index: 83}
      classification:
        isModifier: false
        short: The assignment to an organizing scheme
        mustSupport: false
        array: true
        isSummary: false
        index: 96
        elements:
          type:
            isModifier: false
            short: The kind of classifier (e.g. publication type, keyword)
            mustSupport: false
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/cited-artifact-classification-type'}
            isSummary: false
            index: 97
          classifier:
            isModifier: false
            short: The specific classification value
            mustSupport: false
            array: true
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/citation-artifact-classifier'}
            isSummary: false
            index: 98
          artifactAssessment: {isModifier: false, short: Complex or externally created classification, mustSupport: false, array: true, isSummary: false, index: 99}
      title:
        isModifier: false
        short: The title details of the article or artifact
        mustSupport: false
        array: true
        isSummary: false
        index: 50
        elements:
          type:
            isModifier: false
            short: The kind of title
            mustSupport: false
            array: true
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/title-type'}
            isSummary: false
            index: 51
          language:
            isModifier: false
            short: Used to express the specific language
            mustSupport: false
            binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/languages'}
            isSummary: false
            index: 52
          text: {isModifier: false, short: The title of the article or artifact, mustSupport: false, isSummary: false, index: 53}
        required: [text]
      note: {isModifier: false, short: Any additional information or content for the article or artifact, mustSupport: false, array: true, isSummary: false, index: 118}
      currentState:
        isModifier: false
        short: The status of the cited artifact
        mustSupport: false
        array: true
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/cited-artifact-status-type'}
        isSummary: false
        index: 45
      identifier: {isModifier: false, short: 'Unique identifier. May include DOI, PMID, PMCID, etc', mustSupport: false, array: true, isSummary: true, index: 39}
      statusDate:
        isModifier: false
        short: An effective date or period for a status of the cited artifact
        mustSupport: false
        array: true
        isSummary: false
        index: 46
        elements:
          activity:
            isModifier: false
            short: Classification of the status
            mustSupport: false
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/cited-artifact-status-type'}
            isSummary: false
            index: 47
          actual: {isModifier: false, short: Either occurred or expected, mustSupport: false, isSummary: false, index: 48}
          period: {isModifier: false, short: When the status started and/or ended, mustSupport: false, isSummary: false, index: 49}
        required: [activity, period]
      relatesTo:
        isModifier: false
        short: The artifact related to the cited artifact
        mustSupport: false
        array: true
        isSummary: false
        index: 63
        elements:
          type:
            isModifier: false
            short: documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/related-artifact-type-all|5.0.0'}
            isSummary: false
            index: 64
          classifier:
            isModifier: false
            short: Additional classifiers
            mustSupport: false
            array: true
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/citation-artifact-classifier'}
            isSummary: false
            index: 65
          label: {isModifier: false, short: Short label, mustSupport: false, isSummary: false, index: 66}
          display: {isModifier: false, short: Brief description of the related artifact, mustSupport: false, isSummary: false, index: 67}
          citation: {isModifier: false, short: Bibliographic citation for the artifact, mustSupport: false, isSummary: false, index: 68}
          document: {isModifier: false, short: What document is being referenced, mustSupport: false, isSummary: false, index: 69}
          resource: {isModifier: false, short: What artifact is being referenced, mustSupport: false, isSummary: false, index: 70}
          resourceReference: {isModifier: false, short: 'What artifact, if not a conformance resource', mustSupport: false, isSummary: false, index: 71}
        required: [type]
      contributorship:
        isModifier: false
        short: Attribution of authors and other contributors
        mustSupport: false
        isSummary: false
        index: 100
        elements:
          complete: {isModifier: false, short: Indicates if the list includes all authors and/or contributors, mustSupport: false, isSummary: false, index: 101}
          entry:
            isModifier: false
            short: An individual entity named as a contributor
            mustSupport: false
            array: true
            isSummary: false
            index: 102
            elements:
              contributor: {isModifier: false, short: The identity of the individual contributor, mustSupport: false, isSummary: false, index: 103}
              forenameInitials: {isModifier: false, short: For citation styles that use initials, mustSupport: false, isSummary: false, index: 104}
              affiliation: {isModifier: false, short: Organizational affiliation, mustSupport: false, array: true, isSummary: false, index: 105}
              contributionType:
                isModifier: false
                short: The specific contribution
                mustSupport: false
                array: true
                binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/artifact-contribution-type'}
                isSummary: false
                index: 106
              role:
                isModifier: false
                short: The role of the contributor (e.g. author, editor, reviewer, funder)
                mustSupport: false
                binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/contributor-role'}
                isSummary: false
                index: 107
              contributionInstance:
                isModifier: false
                short: Contributions with accounting for time or number
                mustSupport: false
                array: true
                isSummary: false
                index: 108
                elements:
                  type:
                    isModifier: false
                    short: The specific contribution
                    mustSupport: false
                    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/artifact-contribution-instance-type'}
                    isSummary: false
                    index: 109
                  time: {isModifier: false, short: The time that the contribution was made, mustSupport: false, isSummary: false, index: 110}
                required: [type]
              correspondingContact: {isModifier: false, short: Whether the contributor is the corresponding contributor for the role, mustSupport: false, isSummary: false, index: 111}
              rankingOrder: {isModifier: false, short: Ranked order of contribution, mustSupport: false, isSummary: false, index: 112}
            required: [contributor]
          summary:
            isModifier: false
            short: Used to record a display of the author/contributor list without separate data element for each list member
            mustSupport: false
            array: true
            isSummary: false
            index: 113
            elements:
              type:
                isModifier: false
                short: Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
                mustSupport: false
                binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/contributor-summary-type'}
                isSummary: false
                index: 114
              style:
                isModifier: false
                short: The format for the display string
                mustSupport: false
                binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/contributor-summary-style'}
                isSummary: false
                index: 115
              source:
                isModifier: false
                short: Used to code the producer or rule for creating the display string
                mustSupport: false
                binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/contributor-summary-source'}
                isSummary: false
                index: 116
              value: {isModifier: false, short: 'The display string for the author list, contributor list, or contributorship statement', mustSupport: false, isSummary: false, index: 117}
            required: [value]
      version:
        isModifier: false
        short: The defined version of the cited artifact
        mustSupport: false
        isSummary: false
        index: 42
        elements:
          value: {isModifier: false, short: The version number or other version identifier, mustSupport: false, isSummary: false, index: 43}
          baseCitation: {isModifier: false, short: Citation for the main version of the cited artifact, mustSupport: false, isSummary: false, index: 44}
        required: [value]
      webLocation:
        isModifier: false
        short: Used for any URL for the article or artifact cited
        mustSupport: false
        array: true
        isSummary: false
        index: 93
        elements:
          classifier:
            isModifier: false
            short: Code the reason for different URLs, e.g. abstract and full-text
            mustSupport: false
            array: true
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/artifact-url-classifier'}
            isSummary: false
            index: 94
          url: {isModifier: false, short: The specific URL, mustSupport: false, isSummary: false, index: 95}
      relatedIdentifier: {isModifier: false, short: Identifier not unique to the cited artifact. May include trial registry identifiers, mustSupport: false, array: true, isSummary: true, index: 40}
  endorser: {isModifier: false, short: Who endorsed the citation record, mustSupport: false, array: true, isSummary: false, index: 24}
  publisher: {isModifier: false, short: 'The publisher of the citation record, not the publisher of the article or artifact being cited', mustSupport: false, isSummary: true, index: 10}
  approvalDate: {isModifier: false, short: When the citation record was approved by publisher, mustSupport: false, isSummary: false, index: 18}
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction for citation record (if applicable)
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 14
  purpose: {isModifier: false, short: Why this citation is defined, mustSupport: false, isSummary: false, index: 15}
  name: {isModifier: false, short: Name for this citation record (computer friendly), mustSupport: false, isSummary: true, index: 5}
  copyrightLabel: {isModifier: false, short: 'Copyright holder and year(s) for the ciation record, not for the cited artifact', mustSupport: false, isSummary: false, index: 17}
  useContext: {isModifier: false, short: The context that the citation record content is intended to support, mustSupport: false, array: true, isSummary: true, index: 13}
  copyright: {isModifier: false, short: 'Use and/or publishing restrictions for the citation record, not for the cited artifact', mustSupport: false, isSummary: false, index: 16}
  versionAlgorithm:
    isModifier: false
    short: How to compare versions
    mustSupport: false
    choices: []
    isSummary: true
    index: 4
  experimental: {isModifier: false, short: 'For testing purposes, not real usage', mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 8}
  classification:
    isModifier: false
    short: The assignment to an organizing scheme
    mustSupport: false
    array: true
    isSummary: false
    index: 28
    elements:
      type:
        isModifier: false
        short: The kind of classifier (e.g. publication type, keyword)
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/citation-classification-type'}
        isSummary: false
        index: 29
      classifier:
        isModifier: false
        short: The specific classification value
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/citation-artifact-classifier'}
        isSummary: false
        index: 30
  title: {isModifier: false, short: Name for this citation record (human friendly), mustSupport: false, isSummary: true, index: 6}
  note: {isModifier: false, short: Used for general notes and annotations not coded elsewhere, mustSupport: false, array: true, isSummary: false, index: 31}
  author: {isModifier: false, short: Who authored the citation record, mustSupport: false, array: true, isSummary: false, index: 21}
  summary:
    isModifier: false
    short: A human-readable display of key concepts to represent the citation
    mustSupport: false
    array: true
    isSummary: false
    index: 25
    elements:
      style:
        isModifier: false
        short: Format for display of the citation summary
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/citation-summary-style'}
        isSummary: false
        index: 26
      text: {isModifier: false, short: The human-readable display of the citation summary, mustSupport: false, isSummary: true, index: 27}
    required: [text]
  status:
    isModifier: true
    short: draft | active | retired | unknown
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 7
  currentState:
    isModifier: false
    short: The status of the citation record
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/citation-status-type'}
    isSummary: false
    index: 32
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/Citation', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'}
    isModifier: false
    short: Canonical identifier for this citation record, represented as a globally unique URI
    mustSupport: false
    isSummary: true
    index: 0
  identifier: {isModifier: false, short: Identifier for the citation record itself, mustSupport: false, array: true, isSummary: true, index: 1}
  lastReviewDate: {isModifier: false, short: When the citation record was last reviewed by the publisher, mustSupport: false, isSummary: false, index: 19}
  statusDate:
    isModifier: false
    short: An effective date or period for a status of the citation record
    mustSupport: false
    array: true
    isSummary: false
    index: 33
    elements:
      activity:
        isModifier: false
        short: Classification of the status
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/citation-status-type'}
        isSummary: false
        index: 34
      actual: {isModifier: false, short: Either occurred or expected, mustSupport: false, isSummary: false, index: 35}
      period: {isModifier: false, short: When the status started and/or ended, mustSupport: false, isSummary: false, index: 36}
    required: [activity, period]
  editor: {isModifier: false, short: Who edited the citation record, mustSupport: false, array: true, isSummary: false, index: 22}
  reviewer: {isModifier: false, short: Who reviewed the citation record, mustSupport: false, array: true, isSummary: false, index: 23}
  version: {isModifier: false, short: Business version of the citation record, mustSupport: false, isSummary: true, index: 2}
  relatedArtifact: {isModifier: false, short: Artifact related to the citation record, mustSupport: false, array: true, isSummary: false, index: 37}
  contact: {isModifier: false, short: Contact details for the publisher of the citation record, mustSupport: false, array: true, isSummary: true, index: 11}
  effectivePeriod: {isModifier: false, short: When the citation record is expected to be used, mustSupport: false, isSummary: true, index: 20}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Citation
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [status]