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

This page is part of the Evidence Based Medicine on FHIR Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: BookCitation

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

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

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..*CitationA description of identification, location, or contributorship of a publication (article or artifact)
... citedArtifact
.... identifier 0..*IdentifierUnique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
.... publicationForm
..... publishedIn
...... type 0..1CodeableConceptNot typically used when citing a book itself
...... identifier 0..*IdentifierNot typically used when citing a book itself
...... title 0..1stringNot typically used when citing a book itself
.... Slices for classification 1..*BackboneElementThe assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
..... classification:knowledgeArtifactType S1..1BackboneElementThe assignment to an organizing scheme
...... type
....... coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: knowledge-artifact-type
........ display1..1stringRepresentation defined by the system
Fixed Value: Knowledge Artifact Type
...... Slices for classifier 1..*CodeableConceptThe specific classification value
Slice: Unordered, Open by value:coding
....... classifier:book S1..1CodeableConceptThe specific classification value
........ coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
......... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: D001877
......... display1..1stringRepresentation defined by the system
Fixed Value: Book
..... classification:publishingModel 0..1BackboneElementThe assignment to an organizing scheme
...... type
....... coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: publishing-model
........ display1..1stringRepresentation defined by the system
Fixed Value: Publishing Model
..... classification:publicationType 0..1BackboneElementThe assignment to an organizing scheme
...... type
....... coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: publication-type
........ display1..1stringRepresentation defined by the system
Fixed Value: Publication type
..... classification:definedInText 0..*BackboneElementThe assignment to an organizing scheme
...... type
....... coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
........ system1..1uriIdentity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: defined-in-text
........ display1..1stringRepresentation defined by the system
Fixed Value: Defined in text

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation C0..*CitationA description of identification, location, or contributorship of a publication (article or artifact)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... citedArtifact 0..1BackboneElementThe article or artifact being described
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierUnique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
.... Slices for classification 1..*BackboneElementThe assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
..... classification:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... classification:knowledgeArtifactType S1..1BackboneElementThe assignment to an organizing scheme
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Slices for classifier 1..*CodeableConceptThe specific classification value
Slice: Unordered, Open by value:coding
Binding: CitationArtifactClassifier (example)
....... classifier:book S1..1CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
........ coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
......... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: D001877
......... display1..1stringRepresentation defined by the system
Fixed Value: Book
..... classification:publishingModel 0..1BackboneElementThe assignment to an organizing scheme
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... classification:publicationType 0..1BackboneElementThe assignment to an organizing scheme
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... classification:definedInText 0..*BackboneElementThe assignment to an organizing scheme
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Citation.statusrequiredPublicationStatus
Citation.citedArtifact.classification:knowledgeArtifactType.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:bookexampleCitationArtifactClassifier

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())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation C0..*CitationA description of identification, location, or contributorship of a publication (article or artifact)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this citation record, represented as a globally unique URI
... identifier Σ0..*IdentifierIdentifier for the citation record itself
... version Σ0..1stringBusiness version of the citation record
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this citation record (computer friendly)
... title Σ0..1stringName for this citation record (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringThe publisher of the citation record, not the publisher of the article or artifact being cited
... contact Σ0..*ContactDetailContact details for the publisher of the citation record
... description 0..1markdownNatural language description of the citation
... useContext Σ0..*UsageContextThe context that the citation record content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for citation record (if applicable)
Binding: JurisdictionValueSet (extensible)
... purpose 0..1markdownWhy this citation is defined
... copyright 0..1markdownUse and/or publishing restrictions for the citation record, not for the cited artifact
... copyrightLabel 0..1stringCopyright holder and year(s) for the ciation record, not for the cited artifact
... approvalDate 0..1dateWhen the citation record was approved by publisher
... lastReviewDate 0..1dateWhen the citation record was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the citation record is expected to be used
... author 0..*ContactDetailWho authored the citation record
... editor 0..*ContactDetailWho edited the citation record
... reviewer 0..*ContactDetailWho reviewed the citation record
... endorser 0..*ContactDetailWho endorsed the citation record
... summary 0..*BackboneElementA human-readable display of key concepts to represent the citation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... style 0..1CodeableConceptFormat for display of the citation summary
Binding: CitationSummaryStyle (extensible)
.... text Σ1..1markdownThe human-readable display of the citation summary
... classification 0..*BackboneElementThe assignment to an organizing scheme
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitationClassificationType (extensible)
.... classifier 0..*CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
... note 0..*AnnotationUsed for general notes and annotations not coded elsewhere
... currentState 0..*CodeableConceptThe status of the citation record
Binding: CitationStatusType (example)
... statusDate 0..*BackboneElementAn effective date or period for a status of the citation record
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... activity 1..1CodeableConceptClassification of the status
Binding: CitationStatusType (example)
.... actual 0..1booleanEither occurred or expected
.... period 1..1PeriodWhen the status started and/or ended
... relatedArtifact 0..*RelatedArtifactArtifact related to the citation record
... citedArtifact 0..1BackboneElementThe article or artifact being described
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierUnique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
.... relatedIdentifier Σ0..*IdentifierIdentifier not unique to the cited artifact. May include trial registry identifiers
.... dateAccessed Σ0..1dateTimeWhen the cited artifact was accessed
.... version 0..1BackboneElementThe defined version of the cited artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value 1..1stringThe version number or other version identifier
..... baseCitation 0..1Reference(Citation)Citation for the main version of the cited artifact
.... currentState 0..*CodeableConceptThe status of the cited artifact
Binding: CitedArtifactStatusType (extensible)
.... statusDate 0..*BackboneElementAn effective date or period for a status of the cited artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... activity 1..1CodeableConceptClassification of the status
Binding: CitedArtifactStatusType (extensible)
..... actual 0..1booleanEither occurred or expected
..... period 1..1PeriodWhen the status started and/or ended
.... title 0..*BackboneElementThe title details of the article or artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..*CodeableConceptThe kind of title
Binding: TitleType (extensible)
..... language 0..1CodeableConceptUsed to express the specific language
Binding: CommonLanguages (preferred): A human language.

..... text 1..1markdownThe title of the article or artifact
.... abstract 0..*BackboneElementSummary of the article or artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1CodeableConceptThe kind of abstract
Binding: CitedArtifactAbstractType (extensible)
..... language 0..1CodeableConceptUsed to express the specific language
Binding: CommonLanguages (preferred): A human language.

..... text 1..1markdownAbstract content
..... copyright 0..1markdownCopyright notice for the abstract
.... part 0..1BackboneElementThe component of the article or artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1CodeableConceptThe kind of component
Binding: CitedArtifactPartType (extensible)
..... value 0..1stringThe specification of the component
..... baseCitation 0..1Reference(Citation)The citation for the full article or artifact
.... relatesTo 0..*BackboneElementThe artifact related to the cited artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codedocumentation | 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..*CodeableConceptAdditional classifiers
Binding: CitationArtifactClassifier (extensible)
..... label 0..1stringShort label
..... display 0..1stringBrief description of the related artifact
..... citation 0..1markdownBibliographic citation for the artifact
..... document 0..1AttachmentWhat document is being referenced
..... resource 0..1canonical()What artifact is being referenced
..... resourceReference 0..1Reference()What artifact, if not a conformance resource
.... publicationForm 0..*BackboneElementIf multiple, used to represent alternative forms of the article that are not separate citations
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... publishedIn 0..1BackboneElementThe collection the cited article or artifact is published in
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptNot typically used when citing a book itself
Binding: PublishedInType (extensible)
...... identifier 0..*IdentifierNot typically used when citing a book itself
...... title 0..1stringNot typically used when citing a book itself
...... publisher 0..1Reference(Organization)Name of or resource describing the publisher
...... publisherLocation 0..1stringGeographic location of the publisher
..... citedMedium 0..1CodeableConceptInternet or Print
Binding: CitedMedium (extensible)
..... volume 0..1stringVolume number of journal or other collection in which the article is published
..... issue 0..1stringIssue, part or supplement of journal or other collection in which the article is published
..... articleDate 0..1dateTimeThe date the article was added to the database, or the date the article was released
..... publicationDateText 0..1stringText representation of the date on which the issue of the cited artifact was published
..... publicationDateSeason 0..1stringSeason in which the cited artifact was published
..... lastRevisionDate 0..1dateTimeThe date the article was last revised or updated in the database
..... language 0..*CodeableConceptLanguage(s) in which this form of the article is published
Binding: CommonLanguages (preferred): A human language.


..... accessionNumber 0..1stringEntry number or identifier for inclusion in a database
..... pageString 0..1stringUsed for full display of pagination
..... firstPage 0..1stringUsed for isolated representation of first page
..... lastPage 0..1stringUsed for isolated representation of last page
..... pageCount 0..1stringNumber of pages or screens
..... copyright 0..1markdownCopyright notice for the full article or artifact
.... webLocation 0..*BackboneElementUsed for any URL for the article or artifact cited
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... classifier 0..*CodeableConceptCode the reason for different URLs, e.g. abstract and full-text
Binding: ArtifactUrlClassifier (extensible)
..... url 0..1uriThe specific URL
.... Slices for classification 1..*BackboneElementThe assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
..... classification:All Slices Content/Rules for all slices
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
...... classifier 0..*CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..*Reference(ArtifactAssessment)Complex or externally created classification
..... classification:knowledgeArtifactType S1..1BackboneElementThe assignment to an organizing scheme
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: knowledge-artifact-type
........ display1..1stringRepresentation defined by the system
Fixed Value: Knowledge Artifact Type
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... Slices for classifier 1..*CodeableConceptThe specific classification value
Slice: Unordered, Open by value:coding
Binding: CitationArtifactClassifier (example)
....... classifier:book S1..1CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: D001877
......... display1..1stringRepresentation defined by the system
Fixed Value: Book
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text Σ0..1stringPlain text representation of the concept
...... artifactAssessment 0..*Reference(ArtifactAssessment)Complex or externally created classification
..... classification:publishingModel 0..1BackboneElementThe assignment to an organizing scheme
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: publishing-model
........ display1..1stringRepresentation defined by the system
Fixed Value: Publishing Model
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... classifier 0..*CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..*Reference(ArtifactAssessment)Complex or externally created classification
..... classification:publicationType 0..1BackboneElementThe assignment to an organizing scheme
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: publication-type
........ display1..1stringRepresentation defined by the system
Fixed Value: Publication type
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... classifier 0..*CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..*Reference(ArtifactAssessment)Complex or externally created classification
..... classification:definedInText 0..*BackboneElementThe assignment to an organizing scheme
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: defined-in-text
........ display1..1stringRepresentation defined by the system
Fixed Value: Defined in text
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... classifier 0..*CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..*Reference(ArtifactAssessment)Complex or externally created classification
.... contributorship 0..1BackboneElementAttribution of authors and other contributors
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... complete 0..1booleanIndicates if the list includes all authors and/or contributors
..... entry 0..*BackboneElementAn individual entity named as a contributor
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... contributor 1..1Reference(Practitioner | Organization)The identity of the individual contributor
...... forenameInitials 0..1stringFor citation styles that use initials
...... affiliation 0..*Reference(Organization | PractitionerRole)Organizational affiliation
...... contributionType 0..*CodeableConceptThe specific contribution
Binding: ArtifactContributionType (extensible)
...... role 0..1CodeableConceptThe role of the contributor (e.g. author, editor, reviewer, funder)
Binding: ContributorRole (extensible)
...... contributionInstance 0..*BackboneElementContributions with accounting for time or number
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1CodeableConceptThe specific contribution
Binding: ArtifactContributionInstanceType (extensible)
....... time 0..1dateTimeThe time that the contribution was made
...... correspondingContact 0..1booleanWhether the contributor is the corresponding contributor for the role
...... rankingOrder 0..1positiveIntRanked order of contribution
..... summary 0..*BackboneElementUsed to record a display of the author/contributor list without separate data element for each list member
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptSuch as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
Binding: ContributorSummaryType (extensible)
...... style 0..1CodeableConceptThe format for the display string
Binding: ContributorSummaryStyle (extensible)
...... source 0..1CodeableConceptUsed to code the producer or rule for creating the display string
Binding: ContributorSummarySource (extensible)
...... value 1..1markdownThe display string for the author list, contributor list, or contributorship statement
.... note 0..*AnnotationAny additional information or content for the article or artifact

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Citation.languagerequiredAllLanguages
Citation.versionAlgorithm[x]extensibleVersionAlgorithm
Citation.statusrequiredPublicationStatus
Citation.jurisdictionextensibleJurisdictionValueSet
Citation.summary.styleextensibleCitationSummaryStyle
Citation.classification.typeextensibleCitationClassificationType
Citation.classification.classifierexampleCitationArtifactClassifier
Citation.currentStateexampleCitationStatusType
Citation.statusDate.activityexampleCitationStatusType
Citation.citedArtifact.currentStateextensibleCitedArtifactStatusType
Citation.citedArtifact.statusDate.activityextensibleCitedArtifactStatusType
Citation.citedArtifact.title.typeextensibleTitleType
Citation.citedArtifact.title.languagepreferredCommonLanguages
Citation.citedArtifact.abstract.typeextensibleCitedArtifactAbstractType
Citation.citedArtifact.abstract.languagepreferredCommonLanguages
Citation.citedArtifact.part.typeextensibleCitedArtifactPartType
Citation.citedArtifact.relatesTo.typerequiredRelatedArtifactTypeExpanded
Citation.citedArtifact.relatesTo.classifierextensibleCitationArtifactClassifier
Citation.citedArtifact.publicationForm.publishedIn.typeextensiblePublishedInType
Citation.citedArtifact.publicationForm.citedMediumextensibleCitedMedium
Citation.citedArtifact.publicationForm.languagepreferredCommonLanguages
Citation.citedArtifact.webLocation.classifierextensibleArtifactUrlClassifier
Citation.citedArtifact.classification.typeextensibleCitedArtifactClassificationType
Citation.citedArtifact.classification.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.classification:knowledgeArtifactType.typeextensibleCitedArtifactClassificationType
Citation.citedArtifact.classification:knowledgeArtifactType.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:bookexampleCitationArtifactClassifier
Citation.citedArtifact.classification:publishingModel.typeextensibleCitedArtifactClassificationType
Citation.citedArtifact.classification:publishingModel.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.classification:publicationType.typeextensibleCitedArtifactClassificationType
Citation.citedArtifact.classification:publicationType.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.classification:definedInText.typeextensibleCitedArtifactClassificationType
Citation.citedArtifact.classification:definedInText.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.contributorship.entry.contributionTypeextensibleArtifactContributionType
Citation.citedArtifact.contributorship.entry.roleextensibleContributorRole
Citation.citedArtifact.contributorship.entry.contributionInstance.typeextensibleArtifactContributionInstanceType
Citation.citedArtifact.contributorship.summary.typeextensibleContributorSummaryType
Citation.citedArtifact.contributorship.summary.styleextensibleContributorSummaryStyle
Citation.citedArtifact.contributorship.summary.sourceextensibleContributorSummarySource

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())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

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 Citation.citedArtifact.classification is sliced based on the value of value:type.coding
  • The element Citation.citedArtifact.classification.classifier is sliced based on the value of value:coding

Maturity: 1

Differential View

This structure is derived from Citation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation 0..*CitationA description of identification, location, or contributorship of a publication (article or artifact)
... citedArtifact
.... identifier 0..*IdentifierUnique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
.... publicationForm
..... publishedIn
...... type 0..1CodeableConceptNot typically used when citing a book itself
...... identifier 0..*IdentifierNot typically used when citing a book itself
...... title 0..1stringNot typically used when citing a book itself
.... Slices for classification 1..*BackboneElementThe assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
..... classification:knowledgeArtifactType S1..1BackboneElementThe assignment to an organizing scheme
...... type
....... coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: knowledge-artifact-type
........ display1..1stringRepresentation defined by the system
Fixed Value: Knowledge Artifact Type
...... Slices for classifier 1..*CodeableConceptThe specific classification value
Slice: Unordered, Open by value:coding
....... classifier:book S1..1CodeableConceptThe specific classification value
........ coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
......... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: D001877
......... display1..1stringRepresentation defined by the system
Fixed Value: Book
..... classification:publishingModel 0..1BackboneElementThe assignment to an organizing scheme
...... type
....... coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: publishing-model
........ display1..1stringRepresentation defined by the system
Fixed Value: Publishing Model
..... classification:publicationType 0..1BackboneElementThe assignment to an organizing scheme
...... type
....... coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: publication-type
........ display1..1stringRepresentation defined by the system
Fixed Value: Publication type
..... classification:definedInText 0..*BackboneElementThe assignment to an organizing scheme
...... type
....... coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
........ system1..1uriIdentity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: defined-in-text
........ display1..1stringRepresentation defined by the system
Fixed Value: Defined in text

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation C0..*CitationA description of identification, location, or contributorship of a publication (article or artifact)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... citedArtifact 0..1BackboneElementThe article or artifact being described
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierUnique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
.... Slices for classification 1..*BackboneElementThe assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
..... classification:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... classification:knowledgeArtifactType S1..1BackboneElementThe assignment to an organizing scheme
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... Slices for classifier 1..*CodeableConceptThe specific classification value
Slice: Unordered, Open by value:coding
Binding: CitationArtifactClassifier (example)
....... classifier:book S1..1CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
........ coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
......... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: D001877
......... display1..1stringRepresentation defined by the system
Fixed Value: Book
..... classification:publishingModel 0..1BackboneElementThe assignment to an organizing scheme
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... classification:publicationType 0..1BackboneElementThe assignment to an organizing scheme
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... classification:definedInText 0..*BackboneElementThe assignment to an organizing scheme
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Citation.statusrequiredPublicationStatus
Citation.citedArtifact.classification:knowledgeArtifactType.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:bookexampleCitationArtifactClassifier

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())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation C0..*CitationA description of identification, location, or contributorship of a publication (article or artifact)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this citation record, represented as a globally unique URI
... identifier Σ0..*IdentifierIdentifier for the citation record itself
... version Σ0..1stringBusiness version of the citation record
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this citation record (computer friendly)
... title Σ0..1stringName for this citation record (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringThe publisher of the citation record, not the publisher of the article or artifact being cited
... contact Σ0..*ContactDetailContact details for the publisher of the citation record
... description 0..1markdownNatural language description of the citation
... useContext Σ0..*UsageContextThe context that the citation record content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for citation record (if applicable)
Binding: JurisdictionValueSet (extensible)
... purpose 0..1markdownWhy this citation is defined
... copyright 0..1markdownUse and/or publishing restrictions for the citation record, not for the cited artifact
... copyrightLabel 0..1stringCopyright holder and year(s) for the ciation record, not for the cited artifact
... approvalDate 0..1dateWhen the citation record was approved by publisher
... lastReviewDate 0..1dateWhen the citation record was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the citation record is expected to be used
... author 0..*ContactDetailWho authored the citation record
... editor 0..*ContactDetailWho edited the citation record
... reviewer 0..*ContactDetailWho reviewed the citation record
... endorser 0..*ContactDetailWho endorsed the citation record
... summary 0..*BackboneElementA human-readable display of key concepts to represent the citation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... style 0..1CodeableConceptFormat for display of the citation summary
Binding: CitationSummaryStyle (extensible)
.... text Σ1..1markdownThe human-readable display of the citation summary
... classification 0..*BackboneElementThe assignment to an organizing scheme
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitationClassificationType (extensible)
.... classifier 0..*CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
... note 0..*AnnotationUsed for general notes and annotations not coded elsewhere
... currentState 0..*CodeableConceptThe status of the citation record
Binding: CitationStatusType (example)
... statusDate 0..*BackboneElementAn effective date or period for a status of the citation record
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... activity 1..1CodeableConceptClassification of the status
Binding: CitationStatusType (example)
.... actual 0..1booleanEither occurred or expected
.... period 1..1PeriodWhen the status started and/or ended
... relatedArtifact 0..*RelatedArtifactArtifact related to the citation record
... citedArtifact 0..1BackboneElementThe article or artifact being described
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierUnique identifier. May include ISBN, Bookshelf ID, GTIN, DOI, PMID, etc
.... relatedIdentifier Σ0..*IdentifierIdentifier not unique to the cited artifact. May include trial registry identifiers
.... dateAccessed Σ0..1dateTimeWhen the cited artifact was accessed
.... version 0..1BackboneElementThe defined version of the cited artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value 1..1stringThe version number or other version identifier
..... baseCitation 0..1Reference(Citation)Citation for the main version of the cited artifact
.... currentState 0..*CodeableConceptThe status of the cited artifact
Binding: CitedArtifactStatusType (extensible)
.... statusDate 0..*BackboneElementAn effective date or period for a status of the cited artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... activity 1..1CodeableConceptClassification of the status
Binding: CitedArtifactStatusType (extensible)
..... actual 0..1booleanEither occurred or expected
..... period 1..1PeriodWhen the status started and/or ended
.... title 0..*BackboneElementThe title details of the article or artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..*CodeableConceptThe kind of title
Binding: TitleType (extensible)
..... language 0..1CodeableConceptUsed to express the specific language
Binding: CommonLanguages (preferred): A human language.

..... text 1..1markdownThe title of the article or artifact
.... abstract 0..*BackboneElementSummary of the article or artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1CodeableConceptThe kind of abstract
Binding: CitedArtifactAbstractType (extensible)
..... language 0..1CodeableConceptUsed to express the specific language
Binding: CommonLanguages (preferred): A human language.

..... text 1..1markdownAbstract content
..... copyright 0..1markdownCopyright notice for the abstract
.... part 0..1BackboneElementThe component of the article or artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1CodeableConceptThe kind of component
Binding: CitedArtifactPartType (extensible)
..... value 0..1stringThe specification of the component
..... baseCitation 0..1Reference(Citation)The citation for the full article or artifact
.... relatesTo 0..*BackboneElementThe artifact related to the cited artifact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codedocumentation | 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..*CodeableConceptAdditional classifiers
Binding: CitationArtifactClassifier (extensible)
..... label 0..1stringShort label
..... display 0..1stringBrief description of the related artifact
..... citation 0..1markdownBibliographic citation for the artifact
..... document 0..1AttachmentWhat document is being referenced
..... resource 0..1canonical()What artifact is being referenced
..... resourceReference 0..1Reference()What artifact, if not a conformance resource
.... publicationForm 0..*BackboneElementIf multiple, used to represent alternative forms of the article that are not separate citations
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... publishedIn 0..1BackboneElementThe collection the cited article or artifact is published in
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptNot typically used when citing a book itself
Binding: PublishedInType (extensible)
...... identifier 0..*IdentifierNot typically used when citing a book itself
...... title 0..1stringNot typically used when citing a book itself
...... publisher 0..1Reference(Organization)Name of or resource describing the publisher
...... publisherLocation 0..1stringGeographic location of the publisher
..... citedMedium 0..1CodeableConceptInternet or Print
Binding: CitedMedium (extensible)
..... volume 0..1stringVolume number of journal or other collection in which the article is published
..... issue 0..1stringIssue, part or supplement of journal or other collection in which the article is published
..... articleDate 0..1dateTimeThe date the article was added to the database, or the date the article was released
..... publicationDateText 0..1stringText representation of the date on which the issue of the cited artifact was published
..... publicationDateSeason 0..1stringSeason in which the cited artifact was published
..... lastRevisionDate 0..1dateTimeThe date the article was last revised or updated in the database
..... language 0..*CodeableConceptLanguage(s) in which this form of the article is published
Binding: CommonLanguages (preferred): A human language.


..... accessionNumber 0..1stringEntry number or identifier for inclusion in a database
..... pageString 0..1stringUsed for full display of pagination
..... firstPage 0..1stringUsed for isolated representation of first page
..... lastPage 0..1stringUsed for isolated representation of last page
..... pageCount 0..1stringNumber of pages or screens
..... copyright 0..1markdownCopyright notice for the full article or artifact
.... webLocation 0..*BackboneElementUsed for any URL for the article or artifact cited
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... classifier 0..*CodeableConceptCode the reason for different URLs, e.g. abstract and full-text
Binding: ArtifactUrlClassifier (extensible)
..... url 0..1uriThe specific URL
.... Slices for classification 1..*BackboneElementThe assignment to an organizing scheme
Slice: Unordered, Open by value:type.coding
..... classification:All Slices Content/Rules for all slices
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
...... classifier 0..*CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..*Reference(ArtifactAssessment)Complex or externally created classification
..... classification:knowledgeArtifactType S1..1BackboneElementThe assignment to an organizing scheme
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: knowledge-artifact-type
........ display1..1stringRepresentation defined by the system
Fixed Value: Knowledge Artifact Type
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... Slices for classifier 1..*CodeableConceptThe specific classification value
Slice: Unordered, Open by value:coding
Binding: CitationArtifactClassifier (example)
....... classifier:book S1..1CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/citation-artifact-classifier
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: D001877
......... display1..1stringRepresentation defined by the system
Fixed Value: Book
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text Σ0..1stringPlain text representation of the concept
...... artifactAssessment 0..*Reference(ArtifactAssessment)Complex or externally created classification
..... classification:publishingModel 0..1BackboneElementThe assignment to an organizing scheme
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: publishing-model
........ display1..1stringRepresentation defined by the system
Fixed Value: Publishing Model
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... classifier 0..*CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..*Reference(ArtifactAssessment)Complex or externally created classification
..... classification:publicationType 0..1BackboneElementThe assignment to an organizing scheme
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/cited-artifact-classification-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: publication-type
........ display1..1stringRepresentation defined by the system
Fixed Value: Publication type
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... classifier 0..*CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..*Reference(ArtifactAssessment)Complex or externally created classification
..... classification:definedInText 0..*BackboneElementThe assignment to an organizing scheme
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
Binding: CitedArtifactClassificationType (extensible)
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: defined-in-text
........ display1..1stringRepresentation defined by the system
Fixed Value: Defined in text
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... classifier 0..*CodeableConceptThe specific classification value
Binding: CitationArtifactClassifier (example)
...... artifactAssessment 0..*Reference(ArtifactAssessment)Complex or externally created classification
.... contributorship 0..1BackboneElementAttribution of authors and other contributors
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... complete 0..1booleanIndicates if the list includes all authors and/or contributors
..... entry 0..*BackboneElementAn individual entity named as a contributor
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... contributor 1..1Reference(Practitioner | Organization)The identity of the individual contributor
...... forenameInitials 0..1stringFor citation styles that use initials
...... affiliation 0..*Reference(Organization | PractitionerRole)Organizational affiliation
...... contributionType 0..*CodeableConceptThe specific contribution
Binding: ArtifactContributionType (extensible)
...... role 0..1CodeableConceptThe role of the contributor (e.g. author, editor, reviewer, funder)
Binding: ContributorRole (extensible)
...... contributionInstance 0..*BackboneElementContributions with accounting for time or number
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1CodeableConceptThe specific contribution
Binding: ArtifactContributionInstanceType (extensible)
....... time 0..1dateTimeThe time that the contribution was made
...... correspondingContact 0..1booleanWhether the contributor is the corresponding contributor for the role
...... rankingOrder 0..1positiveIntRanked order of contribution
..... summary 0..*BackboneElementUsed to record a display of the author/contributor list without separate data element for each list member
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 0..1CodeableConceptSuch as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
Binding: ContributorSummaryType (extensible)
...... style 0..1CodeableConceptThe format for the display string
Binding: ContributorSummaryStyle (extensible)
...... source 0..1CodeableConceptUsed to code the producer or rule for creating the display string
Binding: ContributorSummarySource (extensible)
...... value 1..1markdownThe display string for the author list, contributor list, or contributorship statement
.... note 0..*AnnotationAny additional information or content for the article or artifact

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Citation.languagerequiredAllLanguages
Citation.versionAlgorithm[x]extensibleVersionAlgorithm
Citation.statusrequiredPublicationStatus
Citation.jurisdictionextensibleJurisdictionValueSet
Citation.summary.styleextensibleCitationSummaryStyle
Citation.classification.typeextensibleCitationClassificationType
Citation.classification.classifierexampleCitationArtifactClassifier
Citation.currentStateexampleCitationStatusType
Citation.statusDate.activityexampleCitationStatusType
Citation.citedArtifact.currentStateextensibleCitedArtifactStatusType
Citation.citedArtifact.statusDate.activityextensibleCitedArtifactStatusType
Citation.citedArtifact.title.typeextensibleTitleType
Citation.citedArtifact.title.languagepreferredCommonLanguages
Citation.citedArtifact.abstract.typeextensibleCitedArtifactAbstractType
Citation.citedArtifact.abstract.languagepreferredCommonLanguages
Citation.citedArtifact.part.typeextensibleCitedArtifactPartType
Citation.citedArtifact.relatesTo.typerequiredRelatedArtifactTypeExpanded
Citation.citedArtifact.relatesTo.classifierextensibleCitationArtifactClassifier
Citation.citedArtifact.publicationForm.publishedIn.typeextensiblePublishedInType
Citation.citedArtifact.publicationForm.citedMediumextensibleCitedMedium
Citation.citedArtifact.publicationForm.languagepreferredCommonLanguages
Citation.citedArtifact.webLocation.classifierextensibleArtifactUrlClassifier
Citation.citedArtifact.classification.typeextensibleCitedArtifactClassificationType
Citation.citedArtifact.classification.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.classification:knowledgeArtifactType.typeextensibleCitedArtifactClassificationType
Citation.citedArtifact.classification:knowledgeArtifactType.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:bookexampleCitationArtifactClassifier
Citation.citedArtifact.classification:publishingModel.typeextensibleCitedArtifactClassificationType
Citation.citedArtifact.classification:publishingModel.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.classification:publicationType.typeextensibleCitedArtifactClassificationType
Citation.citedArtifact.classification:publicationType.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.classification:definedInText.typeextensibleCitedArtifactClassificationType
Citation.citedArtifact.classification:definedInText.classifierexampleCitationArtifactClassifier
Citation.citedArtifact.contributorship.entry.contributionTypeextensibleArtifactContributionType
Citation.citedArtifact.contributorship.entry.roleextensibleContributorRole
Citation.citedArtifact.contributorship.entry.contributionInstance.typeextensibleArtifactContributionInstanceType
Citation.citedArtifact.contributorship.summary.typeextensibleContributorSummaryType
Citation.citedArtifact.contributorship.summary.styleextensibleContributorSummaryStyle
Citation.citedArtifact.contributorship.summary.sourceextensibleContributorSummarySource

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())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

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 Citation.citedArtifact.classification is sliced based on the value of value:type.coding
  • The element Citation.citedArtifact.classification.classifier is sliced based on the value of value:coding

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron