Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot International flag

Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions

Resource Profile: BookCitation

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/book-citation Version: 2.0.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: BookCitation
Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.6

Profile of Citation for Evidence Based Medicine IG. The BookCitation Profile is used for citations of a book.

See Understanding the Citation Resource for additional information.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Citation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation 0..* Citation A description of identification, location, or contributorship of a publication (article or artifact)
... citedArtifact
.... identifier 0..* Identifier Unique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
.... publicationForm
..... publishedIn
...... type 0..1 CodeableConcept Not typically used when citing a book itself
...... identifier 0..* Identifier Not typically used when citing a book itself
...... title 0..1 string Not typically used when citing a book itself
.... Slices for classification 1..* BackboneElement The assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
..... classification:knowledgeArtifactType S 1..1 BackboneElement The assignment to an organizing scheme
...... type
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: knowledge-artifact-type
........ display 1..1 string Representation defined by the system
Fixed Value: Knowledge Artifact Type
...... Slices for classifier 1..* CodeableConcept The specific classification value
Slice: Unordered, Open by value:coding
....... classifier:book S 1..1 CodeableConcept The specific classification value
........ coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: D001877
......... display 1..1 string Representation defined by the system
Fixed Value: Book
..... classification:publishingModel 0..1 BackboneElement The assignment to an organizing scheme
...... type
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: publishing-model
........ display 1..1 string Representation defined by the system
Fixed Value: Publishing Model
..... classification:publicationType 0..1 BackboneElement The assignment to an organizing scheme
...... type
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: publication-type
........ display 1..1 string Representation defined by the system
Fixed Value: Publication type
..... classification:definedInText 0..* BackboneElement The assignment to an organizing scheme
...... type
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: defined-in-text
........ display 1..1 string Representation defined by the system
Fixed Value: Defined in text

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation C 0..* Citation A description of identification, location, or contributorship of a publication (article or artifact)
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
... citedArtifact 0..1 BackboneElement The article or artifact being described
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
.... identifier Σ 0..* Identifier Unique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
ele-1: All FHIR elements must have a @value or children
.... Slices for classification 1..* BackboneElement The assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
ele-1: All FHIR elements must have a @value or children
..... classification:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
..... classification:knowledgeArtifactType S 1..1 BackboneElement The assignment to an organizing scheme
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
...... Slices for classifier 1..* CodeableConcept The specific classification value
Slice: Unordered, Open by value:coding
Binding: CitationArtifactClassifier (example)
ele-1: All FHIR elements must have a @value or children
....... classifier:book S 1..1 CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
ele-1: All FHIR elements must have a @value or children
........ coding 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: D001877
......... display 1..1 string Representation defined by the system
Fixed Value: Book
..... classification:publishingModel 0..1 BackboneElement The assignment to an organizing scheme
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
..... classification:publicationType 0..1 BackboneElement The assignment to an organizing scheme
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
..... classification:definedInText 0..* BackboneElement The assignment to an organizing scheme
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Citation.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2
from the FHIR Standard
Citation.citedArtifact.classification:knowledgeArtifactType.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:bookexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningCitationName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation C 0..* Citation A description of identification, location, or contributorship of a publication (article or artifact)
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this citation record, represented as a globally unique URI
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Identifier for the citation record itself
... version Σ 0..1 string Business version of the citation record
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this citation record (computer friendly)
... title Σ 0..1 string Name for this citation record (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string The publisher of the citation record, not the publisher of the article or artifact being cited
... contact Σ 0..* ContactDetail Contact details for the publisher of the citation record
... description 0..1 markdown Natural language description of the citation
... useContext Σ 0..* UsageContext The context that the citation record content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for citation record (if applicable)
Binding: JurisdictionValueSet (extensible)
... purpose 0..1 markdown Why this citation is defined
... copyright 0..1 markdown Use and/or publishing restrictions for the citation record, not for the cited artifact
... copyrightLabel 0..1 string Copyright holder and year(s) for the ciation record, not for the cited artifact
... approvalDate 0..1 date When the citation record was approved by publisher
... lastReviewDate 0..1 date When the citation record was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the citation record is expected to be used
... author 0..* ContactDetail Who authored the citation record
... editor 0..* ContactDetail Who edited the citation record
... reviewer 0..* ContactDetail Who reviewed the citation record
... endorser 0..* ContactDetail Who endorsed the citation record
... summary 0..* BackboneElement A human-readable display of key concepts to represent the citation
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... style 0..1 CodeableConcept Format for display of the citation summary
Binding: CitationSummaryStyle (extensible)
.... text Σ 1..1 markdown The human-readable display of the citation summary
... classification 0..* BackboneElement The assignment to an organizing scheme
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitationClassificationType (extensible)
.... classifier 0..* CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
... note 0..* Annotation Used for general notes and annotations not coded elsewhere
... currentState 0..* CodeableConcept The status of the citation record
Binding: CitationStatusType (example)
... statusDate 0..* BackboneElement An effective date or period for a status of the citation record
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... activity 1..1 CodeableConcept Classification of the status
Binding: CitationStatusType (example)
.... actual 0..1 boolean Either occurred or expected
.... period 1..1 Period When the status started and/or ended
... relatedArtifact 0..* RelatedArtifact Artifact related to the citation record
... citedArtifact 0..1 BackboneElement The article or artifact being described
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..* Identifier Unique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
.... relatedIdentifier Σ 0..* Identifier Identifier not unique to the cited artifact. May include trial registry identifiers
.... dateAccessed Σ 0..1 dateTime When the cited artifact was accessed
.... version 0..1 BackboneElement The defined version of the cited artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value 1..1 string The version number or other version identifier
..... baseCitation 0..1 Reference(Citation) Citation for the main version of the cited artifact
.... currentState 0..* CodeableConcept The status of the cited artifact
Binding: CitedArtifactStatusType (extensible)
.... statusDate 0..* BackboneElement An effective date or period for a status of the cited artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... activity 1..1 CodeableConcept Classification of the status
Binding: CitedArtifactStatusType (extensible)
..... actual 0..1 boolean Either occurred or expected
..... period 1..1 Period When the status started and/or ended
.... title 0..* BackboneElement The title details of the article or artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..* CodeableConcept The kind of title
Binding: TitleType (extensible)
..... language 0..1 CodeableConcept Used to express the specific language
Binding: CommonLanguages (preferred): A human language.

..... text 1..1 markdown The title of the article or artifact
.... abstract 0..* BackboneElement Summary of the article or artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept The kind of abstract
Binding: CitedArtifactAbstractType (extensible)
..... language 0..1 CodeableConcept Used to express the specific language
Binding: CommonLanguages (preferred): A human language.

..... text 1..1 markdown Abstract content
..... copyright 0..1 markdown Copyright notice for the abstract
.... part 0..1 BackboneElement The component of the article or artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept The kind of component
Binding: CitedArtifactPartType (extensible)
..... value 0..1 string The specification of the component
..... baseCitation 0..1 Reference(Citation) The citation for the full article or artifact
.... relatesTo 0..* BackboneElement The artifact related to the cited artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code 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
Binding: RelatedArtifactTypeExpanded (required)
..... classifier 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (extensible)
..... label 0..1 string Short label
..... display 0..1 string Brief description of the related artifact
..... citation 0..1 markdown Bibliographic citation for the artifact
..... document 0..1 Attachment What document is being referenced
..... resource 0..1 canonical() What artifact is being referenced
..... resourceReference 0..1 Reference() What artifact, if not a conformance resource
.... publicationForm 0..* BackboneElement If multiple, used to represent alternative forms of the article that are not separate citations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... publishedIn 0..1 BackboneElement The collection the cited article or artifact is published in
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept Not typically used when citing a book itself
Binding: PublishedInType (extensible)
...... identifier 0..* Identifier Not typically used when citing a book itself
...... title 0..1 string Not typically used when citing a book itself
...... publisher 0..1 Reference(Organization) Name of or resource describing the publisher
...... publisherLocation 0..1 string Geographic location of the publisher
..... citedMedium 0..1 CodeableConcept Internet or Print
Binding: CitedMedium (extensible)
..... volume 0..1 string Volume number of journal or other collection in which the article is published
..... issue 0..1 string Issue, part or supplement of journal or other collection in which the article is published
..... articleDate 0..1 dateTime The date the article was added to the database, or the date the article was released
..... publicationDateText 0..1 string Text representation of the date on which the issue of the cited artifact was published
..... publicationDateSeason 0..1 string Season in which the cited artifact was published
..... lastRevisionDate 0..1 dateTime The date the article was last revised or updated in the database
..... language 0..* CodeableConcept Language(s) in which this form of the article is published
Binding: CommonLanguages (preferred): A human language.


..... accessionNumber 0..1 string Entry number or identifier for inclusion in a database
..... pageString 0..1 string Used for full display of pagination
..... firstPage 0..1 string Used for isolated representation of first page
..... lastPage 0..1 string Used for isolated representation of last page
..... pageCount 0..1 string Number of pages or screens
..... copyright 0..1 markdown Copyright notice for the full article or artifact
.... webLocation 0..* BackboneElement Used for any URL for the article or artifact cited
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... classifier 0..* CodeableConcept Code the reason for different URLs, e.g. abstract and full-text
Binding: ArtifactUrlClassifier (extensible)
..... url 0..1 uri The specific URL
.... Slices for classification 1..* BackboneElement The assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
..... classification:All Slices Content/Rules for all slices
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
...... classifier 0..* CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification
..... classification:knowledgeArtifactType S 1..1 BackboneElement The assignment to an organizing scheme
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: knowledge-artifact-type
........ display 1..1 string Representation defined by the system
Fixed Value: Knowledge Artifact Type
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... Slices for classifier 1..* CodeableConcept The specific classification value
Slice: Unordered, Open by value:coding
Binding: CitationArtifactClassifier (example)
....... classifier:book S 1..1 CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: D001877
......... display 1..1 string Representation defined by the system
Fixed Value: Book
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification
..... classification:publishingModel 0..1 BackboneElement The assignment to an organizing scheme
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: publishing-model
........ display 1..1 string Representation defined by the system
Fixed Value: Publishing Model
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... classifier 0..* CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification
..... classification:publicationType 0..1 BackboneElement The assignment to an organizing scheme
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: publication-type
........ display 1..1 string Representation defined by the system
Fixed Value: Publication type
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... classifier 0..* CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification
..... classification:definedInText 0..* BackboneElement The assignment to an organizing scheme
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: defined-in-text
........ display 1..1 string Representation defined by the system
Fixed Value: Defined in text
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... classifier 0..* CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification
.... contributorship 0..1 BackboneElement Attribution of authors and other contributors
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... complete 0..1 boolean Indicates if the list includes all authors and/or contributors
..... entry 0..* BackboneElement An individual entity named as a contributor
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... contributor 1..1 Reference(Practitioner | Organization) The identity of the individual contributor
...... forenameInitials 0..1 string For citation styles that use initials
...... affiliation 0..* Reference(Organization | PractitionerRole) Organizational affiliation
...... contributionType 0..* CodeableConcept The specific contribution
Binding: ArtifactContributionType (extensible)
...... role 0..1 CodeableConcept The role of the contributor (e.g. author, editor, reviewer, funder)
Binding: ContributorRole (extensible)
...... contributionInstance 0..* BackboneElement Contributions with accounting for time or number
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type 1..1 CodeableConcept The specific contribution
Binding: ArtifactContributionInstanceType (extensible)
....... time 0..1 dateTime The time that the contribution was made
...... correspondingContact 0..1 boolean Whether the contributor is the corresponding contributor for the role
...... rankingOrder 0..1 positiveInt Ranked order of contribution
..... summary 0..* BackboneElement Used to record a display of the author/contributor list without separate data element for each list member
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
Binding: ContributorSummaryType (extensible)
...... style 0..1 CodeableConcept The format for the display string
Binding: ContributorSummaryStyle (extensible)
...... source 0..1 CodeableConcept Used to code the producer or rule for creating the display string
Binding: ContributorSummarySource (extensible)
...... value 1..1 markdown The display string for the author list, contributor list, or contributorship statement
.... note 0..* Annotation Any additional information or content for the article or artifact

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Citation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2
from the FHIR Standard
Citation.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
Citation.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2
from the FHIR Standard
Citation.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Citation.summary.styleextensibleCitationSummaryStyle
http://hl7.org/fhir/ValueSet/citation-summary-style
from the FHIR Standard
Citation.classification.typeextensibleCitationClassificationType
http://hl7.org/fhir/ValueSet/citation-classification-type
from the FHIR Standard
Citation.classification.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.currentStateexampleCitationStatusType
http://hl7.org/fhir/ValueSet/citation-status-type
from the FHIR Standard
Citation.statusDate.activityexampleCitationStatusType
http://hl7.org/fhir/ValueSet/citation-status-type
from the FHIR Standard
Citation.citedArtifact.currentStateextensibleCitedArtifactStatusType
http://hl7.org/fhir/ValueSet/cited-artifact-status-type
from the FHIR Standard
Citation.citedArtifact.statusDate.activityextensibleCitedArtifactStatusType
http://hl7.org/fhir/ValueSet/cited-artifact-status-type
from the FHIR Standard
Citation.citedArtifact.title.typeextensibleTitleType
http://hl7.org/fhir/ValueSet/title-type
from the FHIR Standard
Citation.citedArtifact.title.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Citation.citedArtifact.abstract.typeextensibleCitedArtifactAbstractType
http://hl7.org/fhir/ValueSet/cited-artifact-abstract-type
from the FHIR Standard
Citation.citedArtifact.abstract.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Citation.citedArtifact.part.typeextensibleCitedArtifactPartType
http://hl7.org/fhir/ValueSet/cited-artifact-part-type
from the FHIR Standard
Citation.citedArtifact.relatesTo.typerequiredRelatedArtifactTypeExpanded
http://hl7.org/fhir/ValueSet/related-artifact-type-all|6.0.0-ballot2
from the FHIR Standard
Citation.citedArtifact.relatesTo.classifierextensibleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.publicationForm.publishedIn.typeextensiblePublishedInType
http://hl7.org/fhir/ValueSet/published-in-type
from the FHIR Standard
Citation.citedArtifact.publicationForm.citedMediumextensibleCitedMedium
http://hl7.org/fhir/ValueSet/cited-medium
from the FHIR Standard
Citation.citedArtifact.publicationForm.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Citation.citedArtifact.webLocation.classifierextensibleArtifactUrlClassifier
http://hl7.org/fhir/ValueSet/artifact-url-classifier
from the FHIR Standard
Citation.citedArtifact.classification.typeextensibleCitedArtifactClassificationType
http://hl7.org/fhir/ValueSet/cited-artifact-classification-type
from the FHIR Standard
Citation.citedArtifact.classification.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:knowledgeArtifactType.typeextensibleCitedArtifactClassificationType
http://hl7.org/fhir/ValueSet/cited-artifact-classification-type
from the FHIR Standard
Citation.citedArtifact.classification:knowledgeArtifactType.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:bookexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:publishingModel.typeextensibleCitedArtifactClassificationType
http://hl7.org/fhir/ValueSet/cited-artifact-classification-type
from the FHIR Standard
Citation.citedArtifact.classification:publishingModel.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:publicationType.typeextensibleCitedArtifactClassificationType
http://hl7.org/fhir/ValueSet/cited-artifact-classification-type
from the FHIR Standard
Citation.citedArtifact.classification:publicationType.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:definedInText.typeextensibleCitedArtifactClassificationType
http://hl7.org/fhir/ValueSet/cited-artifact-classification-type
from the FHIR Standard
Citation.citedArtifact.classification:definedInText.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.contributorship.entry.contributionTypeextensibleArtifactContributionType
http://hl7.org/fhir/ValueSet/artifact-contribution-type
from the FHIR Standard
Citation.citedArtifact.contributorship.entry.roleextensibleContributorRole
http://hl7.org/fhir/ValueSet/contributor-role
from the FHIR Standard
Citation.citedArtifact.contributorship.entry.contributionInstance.typeextensibleArtifactContributionInstanceType
http://hl7.org/fhir/ValueSet/artifact-contribution-instance-type
from the FHIR Standard
Citation.citedArtifact.contributorship.summary.typeextensibleContributorSummaryType
http://hl7.org/fhir/ValueSet/contributor-summary-type
from the FHIR Standard
Citation.citedArtifact.contributorship.summary.styleextensibleContributorSummaryStyle
http://hl7.org/fhir/ValueSet/contributor-summary-style
from the FHIR Standard
Citation.citedArtifact.contributorship.summary.sourceextensibleContributorSummarySource
http://hl7.org/fhir/ValueSet/contributor-summary-source
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningCitationName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningCitation.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from Citation

Summary

Mandatory: 0 element(9 nested mandatory elements)
Must-Support: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Citation.citedArtifact.classification
  • The element 1 is sliced based on the value of Citation.citedArtifact.classification.classifier

Maturity: 1

Differential View

This structure is derived from Citation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation 0..* Citation A description of identification, location, or contributorship of a publication (article or artifact)
... citedArtifact
.... identifier 0..* Identifier Unique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
.... publicationForm
..... publishedIn
...... type 0..1 CodeableConcept Not typically used when citing a book itself
...... identifier 0..* Identifier Not typically used when citing a book itself
...... title 0..1 string Not typically used when citing a book itself
.... Slices for classification 1..* BackboneElement The assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
..... classification:knowledgeArtifactType S 1..1 BackboneElement The assignment to an organizing scheme
...... type
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: knowledge-artifact-type
........ display 1..1 string Representation defined by the system
Fixed Value: Knowledge Artifact Type
...... Slices for classifier 1..* CodeableConcept The specific classification value
Slice: Unordered, Open by value:coding
....... classifier:book S 1..1 CodeableConcept The specific classification value
........ coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: D001877
......... display 1..1 string Representation defined by the system
Fixed Value: Book
..... classification:publishingModel 0..1 BackboneElement The assignment to an organizing scheme
...... type
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: publishing-model
........ display 1..1 string Representation defined by the system
Fixed Value: Publishing Model
..... classification:publicationType 0..1 BackboneElement The assignment to an organizing scheme
...... type
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: publication-type
........ display 1..1 string Representation defined by the system
Fixed Value: Publication type
..... classification:definedInText 0..* BackboneElement The assignment to an organizing scheme
...... type
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: defined-in-text
........ display 1..1 string Representation defined by the system
Fixed Value: Defined in text

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation C 0..* Citation A description of identification, location, or contributorship of a publication (article or artifact)
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
... citedArtifact 0..1 BackboneElement The article or artifact being described
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
.... identifier Σ 0..* Identifier Unique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
ele-1: All FHIR elements must have a @value or children
.... Slices for classification 1..* BackboneElement The assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
ele-1: All FHIR elements must have a @value or children
..... classification:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
..... classification:knowledgeArtifactType S 1..1 BackboneElement The assignment to an organizing scheme
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
...... Slices for classifier 1..* CodeableConcept The specific classification value
Slice: Unordered, Open by value:coding
Binding: CitationArtifactClassifier (example)
ele-1: All FHIR elements must have a @value or children
....... classifier:book S 1..1 CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
ele-1: All FHIR elements must have a @value or children
........ coding 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: D001877
......... display 1..1 string Representation defined by the system
Fixed Value: Book
..... classification:publishingModel 0..1 BackboneElement The assignment to an organizing scheme
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
..... classification:publicationType 0..1 BackboneElement The assignment to an organizing scheme
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
..... classification:definedInText 0..* BackboneElement The assignment to an organizing scheme
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Citation.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2
from the FHIR Standard
Citation.citedArtifact.classification:knowledgeArtifactType.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:bookexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningCitationName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation C 0..* Citation A description of identification, location, or contributorship of a publication (article or artifact)
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this citation record, represented as a globally unique URI
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Identifier for the citation record itself
... version Σ 0..1 string Business version of the citation record
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this citation record (computer friendly)
... title Σ 0..1 string Name for this citation record (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string The publisher of the citation record, not the publisher of the article or artifact being cited
... contact Σ 0..* ContactDetail Contact details for the publisher of the citation record
... description 0..1 markdown Natural language description of the citation
... useContext Σ 0..* UsageContext The context that the citation record content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for citation record (if applicable)
Binding: JurisdictionValueSet (extensible)
... purpose 0..1 markdown Why this citation is defined
... copyright 0..1 markdown Use and/or publishing restrictions for the citation record, not for the cited artifact
... copyrightLabel 0..1 string Copyright holder and year(s) for the ciation record, not for the cited artifact
... approvalDate 0..1 date When the citation record was approved by publisher
... lastReviewDate 0..1 date When the citation record was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the citation record is expected to be used
... author 0..* ContactDetail Who authored the citation record
... editor 0..* ContactDetail Who edited the citation record
... reviewer 0..* ContactDetail Who reviewed the citation record
... endorser 0..* ContactDetail Who endorsed the citation record
... summary 0..* BackboneElement A human-readable display of key concepts to represent the citation
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... style 0..1 CodeableConcept Format for display of the citation summary
Binding: CitationSummaryStyle (extensible)
.... text Σ 1..1 markdown The human-readable display of the citation summary
... classification 0..* BackboneElement The assignment to an organizing scheme
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitationClassificationType (extensible)
.... classifier 0..* CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
... note 0..* Annotation Used for general notes and annotations not coded elsewhere
... currentState 0..* CodeableConcept The status of the citation record
Binding: CitationStatusType (example)
... statusDate 0..* BackboneElement An effective date or period for a status of the citation record
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... activity 1..1 CodeableConcept Classification of the status
Binding: CitationStatusType (example)
.... actual 0..1 boolean Either occurred or expected
.... period 1..1 Period When the status started and/or ended
... relatedArtifact 0..* RelatedArtifact Artifact related to the citation record
... citedArtifact 0..1 BackboneElement The article or artifact being described
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..* Identifier Unique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
.... relatedIdentifier Σ 0..* Identifier Identifier not unique to the cited artifact. May include trial registry identifiers
.... dateAccessed Σ 0..1 dateTime When the cited artifact was accessed
.... version 0..1 BackboneElement The defined version of the cited artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value 1..1 string The version number or other version identifier
..... baseCitation 0..1 Reference(Citation) Citation for the main version of the cited artifact
.... currentState 0..* CodeableConcept The status of the cited artifact
Binding: CitedArtifactStatusType (extensible)
.... statusDate 0..* BackboneElement An effective date or period for a status of the cited artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... activity 1..1 CodeableConcept Classification of the status
Binding: CitedArtifactStatusType (extensible)
..... actual 0..1 boolean Either occurred or expected
..... period 1..1 Period When the status started and/or ended
.... title 0..* BackboneElement The title details of the article or artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..* CodeableConcept The kind of title
Binding: TitleType (extensible)
..... language 0..1 CodeableConcept Used to express the specific language
Binding: CommonLanguages (preferred): A human language.

..... text 1..1 markdown The title of the article or artifact
.... abstract 0..* BackboneElement Summary of the article or artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept The kind of abstract
Binding: CitedArtifactAbstractType (extensible)
..... language 0..1 CodeableConcept Used to express the specific language
Binding: CommonLanguages (preferred): A human language.

..... text 1..1 markdown Abstract content
..... copyright 0..1 markdown Copyright notice for the abstract
.... part 0..1 BackboneElement The component of the article or artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept The kind of component
Binding: CitedArtifactPartType (extensible)
..... value 0..1 string The specification of the component
..... baseCitation 0..1 Reference(Citation) The citation for the full article or artifact
.... relatesTo 0..* BackboneElement The artifact related to the cited artifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code 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
Binding: RelatedArtifactTypeExpanded (required)
..... classifier 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (extensible)
..... label 0..1 string Short label
..... display 0..1 string Brief description of the related artifact
..... citation 0..1 markdown Bibliographic citation for the artifact
..... document 0..1 Attachment What document is being referenced
..... resource 0..1 canonical() What artifact is being referenced
..... resourceReference 0..1 Reference() What artifact, if not a conformance resource
.... publicationForm 0..* BackboneElement If multiple, used to represent alternative forms of the article that are not separate citations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... publishedIn 0..1 BackboneElement The collection the cited article or artifact is published in
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept Not typically used when citing a book itself
Binding: PublishedInType (extensible)
...... identifier 0..* Identifier Not typically used when citing a book itself
...... title 0..1 string Not typically used when citing a book itself
...... publisher 0..1 Reference(Organization) Name of or resource describing the publisher
...... publisherLocation 0..1 string Geographic location of the publisher
..... citedMedium 0..1 CodeableConcept Internet or Print
Binding: CitedMedium (extensible)
..... volume 0..1 string Volume number of journal or other collection in which the article is published
..... issue 0..1 string Issue, part or supplement of journal or other collection in which the article is published
..... articleDate 0..1 dateTime The date the article was added to the database, or the date the article was released
..... publicationDateText 0..1 string Text representation of the date on which the issue of the cited artifact was published
..... publicationDateSeason 0..1 string Season in which the cited artifact was published
..... lastRevisionDate 0..1 dateTime The date the article was last revised or updated in the database
..... language 0..* CodeableConcept Language(s) in which this form of the article is published
Binding: CommonLanguages (preferred): A human language.


..... accessionNumber 0..1 string Entry number or identifier for inclusion in a database
..... pageString 0..1 string Used for full display of pagination
..... firstPage 0..1 string Used for isolated representation of first page
..... lastPage 0..1 string Used for isolated representation of last page
..... pageCount 0..1 string Number of pages or screens
..... copyright 0..1 markdown Copyright notice for the full article or artifact
.... webLocation 0..* BackboneElement Used for any URL for the article or artifact cited
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... classifier 0..* CodeableConcept Code the reason for different URLs, e.g. abstract and full-text
Binding: ArtifactUrlClassifier (extensible)
..... url 0..1 uri The specific URL
.... Slices for classification 1..* BackboneElement The assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
..... classification:All Slices Content/Rules for all slices
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
...... classifier 0..* CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification
..... classification:knowledgeArtifactType S 1..1 BackboneElement The assignment to an organizing scheme
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: knowledge-artifact-type
........ display 1..1 string Representation defined by the system
Fixed Value: Knowledge Artifact Type
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... Slices for classifier 1..* CodeableConcept The specific classification value
Slice: Unordered, Open by value:coding
Binding: CitationArtifactClassifier (example)
....... classifier:book S 1..1 CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: D001877
......... display 1..1 string Representation defined by the system
Fixed Value: Book
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification
..... classification:publishingModel 0..1 BackboneElement The assignment to an organizing scheme
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: publishing-model
........ display 1..1 string Representation defined by the system
Fixed Value: Publishing Model
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... classifier 0..* CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification
..... classification:publicationType 0..1 BackboneElement The assignment to an organizing scheme
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: publication-type
........ display 1..1 string Representation defined by the system
Fixed Value: Publication type
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... classifier 0..* CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification
..... classification:definedInText 0..* BackboneElement The assignment to an organizing scheme
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: defined-in-text
........ display 1..1 string Representation defined by the system
Fixed Value: Defined in text
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... classifier 0..* CodeableConcept The specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification
.... contributorship 0..1 BackboneElement Attribution of authors and other contributors
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... complete 0..1 boolean Indicates if the list includes all authors and/or contributors
..... entry 0..* BackboneElement An individual entity named as a contributor
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... contributor 1..1 Reference(Practitioner | Organization) The identity of the individual contributor
...... forenameInitials 0..1 string For citation styles that use initials
...... affiliation 0..* Reference(Organization | PractitionerRole) Organizational affiliation
...... contributionType 0..* CodeableConcept The specific contribution
Binding: ArtifactContributionType (extensible)
...... role 0..1 CodeableConcept The role of the contributor (e.g. author, editor, reviewer, funder)
Binding: ContributorRole (extensible)
...... contributionInstance 0..* BackboneElement Contributions with accounting for time or number
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... type 1..1 CodeableConcept The specific contribution
Binding: ArtifactContributionInstanceType (extensible)
....... time 0..1 dateTime The time that the contribution was made
...... correspondingContact 0..1 boolean Whether the contributor is the corresponding contributor for the role
...... rankingOrder 0..1 positiveInt Ranked order of contribution
..... summary 0..* BackboneElement Used to record a display of the author/contributor list without separate data element for each list member
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 0..1 CodeableConcept Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
Binding: ContributorSummaryType (extensible)
...... style 0..1 CodeableConcept The format for the display string
Binding: ContributorSummaryStyle (extensible)
...... source 0..1 CodeableConcept Used to code the producer or rule for creating the display string
Binding: ContributorSummarySource (extensible)
...... value 1..1 markdown The display string for the author list, contributor list, or contributorship statement
.... note 0..* Annotation Any additional information or content for the article or artifact

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Citation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2
from the FHIR Standard
Citation.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
Citation.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2
from the FHIR Standard
Citation.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Citation.summary.styleextensibleCitationSummaryStyle
http://hl7.org/fhir/ValueSet/citation-summary-style
from the FHIR Standard
Citation.classification.typeextensibleCitationClassificationType
http://hl7.org/fhir/ValueSet/citation-classification-type
from the FHIR Standard
Citation.classification.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.currentStateexampleCitationStatusType
http://hl7.org/fhir/ValueSet/citation-status-type
from the FHIR Standard
Citation.statusDate.activityexampleCitationStatusType
http://hl7.org/fhir/ValueSet/citation-status-type
from the FHIR Standard
Citation.citedArtifact.currentStateextensibleCitedArtifactStatusType
http://hl7.org/fhir/ValueSet/cited-artifact-status-type
from the FHIR Standard
Citation.citedArtifact.statusDate.activityextensibleCitedArtifactStatusType
http://hl7.org/fhir/ValueSet/cited-artifact-status-type
from the FHIR Standard
Citation.citedArtifact.title.typeextensibleTitleType
http://hl7.org/fhir/ValueSet/title-type
from the FHIR Standard
Citation.citedArtifact.title.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Citation.citedArtifact.abstract.typeextensibleCitedArtifactAbstractType
http://hl7.org/fhir/ValueSet/cited-artifact-abstract-type
from the FHIR Standard
Citation.citedArtifact.abstract.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Citation.citedArtifact.part.typeextensibleCitedArtifactPartType
http://hl7.org/fhir/ValueSet/cited-artifact-part-type
from the FHIR Standard
Citation.citedArtifact.relatesTo.typerequiredRelatedArtifactTypeExpanded
http://hl7.org/fhir/ValueSet/related-artifact-type-all|6.0.0-ballot2
from the FHIR Standard
Citation.citedArtifact.relatesTo.classifierextensibleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.publicationForm.publishedIn.typeextensiblePublishedInType
http://hl7.org/fhir/ValueSet/published-in-type
from the FHIR Standard
Citation.citedArtifact.publicationForm.citedMediumextensibleCitedMedium
http://hl7.org/fhir/ValueSet/cited-medium
from the FHIR Standard
Citation.citedArtifact.publicationForm.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Citation.citedArtifact.webLocation.classifierextensibleArtifactUrlClassifier
http://hl7.org/fhir/ValueSet/artifact-url-classifier
from the FHIR Standard
Citation.citedArtifact.classification.typeextensibleCitedArtifactClassificationType
http://hl7.org/fhir/ValueSet/cited-artifact-classification-type
from the FHIR Standard
Citation.citedArtifact.classification.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:knowledgeArtifactType.typeextensibleCitedArtifactClassificationType
http://hl7.org/fhir/ValueSet/cited-artifact-classification-type
from the FHIR Standard
Citation.citedArtifact.classification:knowledgeArtifactType.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:bookexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:publishingModel.typeextensibleCitedArtifactClassificationType
http://hl7.org/fhir/ValueSet/cited-artifact-classification-type
from the FHIR Standard
Citation.citedArtifact.classification:publishingModel.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:publicationType.typeextensibleCitedArtifactClassificationType
http://hl7.org/fhir/ValueSet/cited-artifact-classification-type
from the FHIR Standard
Citation.citedArtifact.classification:publicationType.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.classification:definedInText.typeextensibleCitedArtifactClassificationType
http://hl7.org/fhir/ValueSet/cited-artifact-classification-type
from the FHIR Standard
Citation.citedArtifact.classification:definedInText.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Citation.citedArtifact.contributorship.entry.contributionTypeextensibleArtifactContributionType
http://hl7.org/fhir/ValueSet/artifact-contribution-type
from the FHIR Standard
Citation.citedArtifact.contributorship.entry.roleextensibleContributorRole
http://hl7.org/fhir/ValueSet/contributor-role
from the FHIR Standard
Citation.citedArtifact.contributorship.entry.contributionInstance.typeextensibleArtifactContributionInstanceType
http://hl7.org/fhir/ValueSet/artifact-contribution-instance-type
from the FHIR Standard
Citation.citedArtifact.contributorship.summary.typeextensibleContributorSummaryType
http://hl7.org/fhir/ValueSet/contributor-summary-type
from the FHIR Standard
Citation.citedArtifact.contributorship.summary.styleextensibleContributorSummaryStyle
http://hl7.org/fhir/ValueSet/contributor-summary-style
from the FHIR Standard
Citation.citedArtifact.contributorship.summary.sourceextensibleContributorSummarySource
http://hl7.org/fhir/ValueSet/contributor-summary-source
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningCitationName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningCitation.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from Citation

Summary

Mandatory: 0 element(9 nested mandatory elements)
Must-Support: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Citation.citedArtifact.classification
  • The element 1 is sliced based on the value of Citation.citedArtifact.classification.classifier

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron