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
Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/database-citation | Version: 1.0.0-ballot | |||
Standards status: Draft | Maturity Level: 1 | Computable Name: DatabaseCitation |
Profile of Citation for Evidence Based Medicine IG. The DatabaseCitation Profile is used for citations of a database.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Citation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Citation | 0..* | Citation | A description of identification, location, or contributorship of a publication (article or artifact) | |
citedArtifact | ||||
identifier | 0..* | Identifier | Unique identifier. | |
publicationForm | ||||
publishedIn | ||||
type | 0..1 | CodeableConcept | Not typically used when citing a database itself | |
identifier | 0..* | Identifier | Not typically used when citing a database itself | |
title | 0..1 | string | Not typically used when citing a database 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:database | 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: D019991 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Database | |
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 | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Citation | C | 0..* | Citation | A description of identification, location, or contributorship of a publication (article or artifact) |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
citedArtifact | 0..1 | BackboneElement | The article or artifact being described | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | Σ | 0..* | Identifier | Unique identifier. |
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 | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
classification:knowledgeArtifactType | S | 1..1 | BackboneElement | The assignment to an organizing scheme |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Slices for classifier | 1..* | CodeableConcept | The specific classification value Slice: Unordered, Open by value:coding Binding: CitationArtifactClassifier (example) | |
classifier:database | S | 1..1 | CodeableConcept | The specific classification value Binding: CitationArtifactClassifier (example) |
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: D019991 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Database | |
classification:definedInText | 0..* | BackboneElement | The assignment to an organizing scheme | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format |
Path | Conformance | ValueSet |
Citation.status | required | PublicationStatus |
Citation.citedArtifact.classification:knowledgeArtifactType.classifier | example | CitationArtifactClassifier |
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:database | example | CitationArtifactClassifier |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Citation | Name 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Citation | C | 0..* | Citation | A description of identification, location, or contributorship of a publication (article or artifact) | ||||
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
| |||||
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 | ||||
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. | ||||
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 database itself Binding: PublishedInType (extensible) | |||||
identifier | 0..* | Identifier | Not typically used when citing a database itself | |||||
title | 0..1 | string | Not typically used when citing a database 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:database | 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: D019991 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Database | |||||
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: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 | |||||
Documentation for this format |
Path | Conformance | ValueSet |
Citation.language | required | AllLanguages |
Citation.versionAlgorithm[x] | extensible | VersionAlgorithm |
Citation.status | required | PublicationStatus |
Citation.jurisdiction | extensible | JurisdictionValueSet |
Citation.summary.style | extensible | CitationSummaryStyle |
Citation.classification.type | extensible | CitationClassificationType |
Citation.classification.classifier | example | CitationArtifactClassifier |
Citation.currentState | example | CitationStatusType |
Citation.statusDate.activity | example | CitationStatusType |
Citation.citedArtifact.currentState | extensible | CitedArtifactStatusType |
Citation.citedArtifact.statusDate.activity | extensible | CitedArtifactStatusType |
Citation.citedArtifact.title.type | extensible | TitleType |
Citation.citedArtifact.title.language | preferred | CommonLanguages |
Citation.citedArtifact.abstract.type | extensible | CitedArtifactAbstractType |
Citation.citedArtifact.abstract.language | preferred | CommonLanguages |
Citation.citedArtifact.part.type | extensible | CitedArtifactPartType |
Citation.citedArtifact.relatesTo.type | required | RelatedArtifactTypeExpanded |
Citation.citedArtifact.relatesTo.classifier | extensible | CitationArtifactClassifier |
Citation.citedArtifact.publicationForm.publishedIn.type | extensible | PublishedInType |
Citation.citedArtifact.publicationForm.citedMedium | extensible | CitedMedium |
Citation.citedArtifact.publicationForm.language | preferred | CommonLanguages |
Citation.citedArtifact.webLocation.classifier | extensible | ArtifactUrlClassifier |
Citation.citedArtifact.classification.type | extensible | CitedArtifactClassificationType |
Citation.citedArtifact.classification.classifier | example | CitationArtifactClassifier |
Citation.citedArtifact.classification:knowledgeArtifactType.type | extensible | CitedArtifactClassificationType |
Citation.citedArtifact.classification:knowledgeArtifactType.classifier | example | CitationArtifactClassifier |
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:database | example | CitationArtifactClassifier |
Citation.citedArtifact.classification:definedInText.type | extensible | CitedArtifactClassificationType |
Citation.citedArtifact.classification:definedInText.classifier | example | CitationArtifactClassifier |
Citation.citedArtifact.contributorship.entry.contributionType | extensible | ArtifactContributionType |
Citation.citedArtifact.contributorship.entry.role | extensible | ContributorRole |
Citation.citedArtifact.contributorship.entry.contributionInstance.type | extensible | ArtifactContributionInstanceType |
Citation.citedArtifact.contributorship.summary.type | extensible | ContributorSummaryType |
Citation.citedArtifact.contributorship.summary.style | extensible | ContributorSummaryStyle |
Citation.citedArtifact.contributorship.summary.source | extensible | ContributorSummarySource |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Citation | Name 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-1 | warning | Citation.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Citation
Summary
Mandatory: 0 element (7 nested mandatory elements)
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from Citation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Citation | 0..* | Citation | A description of identification, location, or contributorship of a publication (article or artifact) | |
citedArtifact | ||||
identifier | 0..* | Identifier | Unique identifier. | |
publicationForm | ||||
publishedIn | ||||
type | 0..1 | CodeableConcept | Not typically used when citing a database itself | |
identifier | 0..* | Identifier | Not typically used when citing a database itself | |
title | 0..1 | string | Not typically used when citing a database 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:database | 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: D019991 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Database | |
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 | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Citation | C | 0..* | Citation | A description of identification, location, or contributorship of a publication (article or artifact) |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
citedArtifact | 0..1 | BackboneElement | The article or artifact being described | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | Σ | 0..* | Identifier | Unique identifier. |
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 | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
classification:knowledgeArtifactType | S | 1..1 | BackboneElement | The assignment to an organizing scheme |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Slices for classifier | 1..* | CodeableConcept | The specific classification value Slice: Unordered, Open by value:coding Binding: CitationArtifactClassifier (example) | |
classifier:database | S | 1..1 | CodeableConcept | The specific classification value Binding: CitationArtifactClassifier (example) |
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: D019991 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Database | |
classification:definedInText | 0..* | BackboneElement | The assignment to an organizing scheme | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format |
Path | Conformance | ValueSet |
Citation.status | required | PublicationStatus |
Citation.citedArtifact.classification:knowledgeArtifactType.classifier | example | CitationArtifactClassifier |
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:database | example | CitationArtifactClassifier |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Citation | Name 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-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Citation | C | 0..* | Citation | A description of identification, location, or contributorship of a publication (article or artifact) | ||||
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
| |||||
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 | ||||
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. | ||||
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 database itself Binding: PublishedInType (extensible) | |||||
identifier | 0..* | Identifier | Not typically used when citing a database itself | |||||
title | 0..1 | string | Not typically used when citing a database 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:database | 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: D019991 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Database | |||||
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: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 | |||||
Documentation for this format |
Path | Conformance | ValueSet |
Citation.language | required | AllLanguages |
Citation.versionAlgorithm[x] | extensible | VersionAlgorithm |
Citation.status | required | PublicationStatus |
Citation.jurisdiction | extensible | JurisdictionValueSet |
Citation.summary.style | extensible | CitationSummaryStyle |
Citation.classification.type | extensible | CitationClassificationType |
Citation.classification.classifier | example | CitationArtifactClassifier |
Citation.currentState | example | CitationStatusType |
Citation.statusDate.activity | example | CitationStatusType |
Citation.citedArtifact.currentState | extensible | CitedArtifactStatusType |
Citation.citedArtifact.statusDate.activity | extensible | CitedArtifactStatusType |
Citation.citedArtifact.title.type | extensible | TitleType |
Citation.citedArtifact.title.language | preferred | CommonLanguages |
Citation.citedArtifact.abstract.type | extensible | CitedArtifactAbstractType |
Citation.citedArtifact.abstract.language | preferred | CommonLanguages |
Citation.citedArtifact.part.type | extensible | CitedArtifactPartType |
Citation.citedArtifact.relatesTo.type | required | RelatedArtifactTypeExpanded |
Citation.citedArtifact.relatesTo.classifier | extensible | CitationArtifactClassifier |
Citation.citedArtifact.publicationForm.publishedIn.type | extensible | PublishedInType |
Citation.citedArtifact.publicationForm.citedMedium | extensible | CitedMedium |
Citation.citedArtifact.publicationForm.language | preferred | CommonLanguages |
Citation.citedArtifact.webLocation.classifier | extensible | ArtifactUrlClassifier |
Citation.citedArtifact.classification.type | extensible | CitedArtifactClassificationType |
Citation.citedArtifact.classification.classifier | example | CitationArtifactClassifier |
Citation.citedArtifact.classification:knowledgeArtifactType.type | extensible | CitedArtifactClassificationType |
Citation.citedArtifact.classification:knowledgeArtifactType.classifier | example | CitationArtifactClassifier |
Citation.citedArtifact.classification:knowledgeArtifactType.classifier:database | example | CitationArtifactClassifier |
Citation.citedArtifact.classification:definedInText.type | extensible | CitedArtifactClassificationType |
Citation.citedArtifact.classification:definedInText.classifier | example | CitationArtifactClassifier |
Citation.citedArtifact.contributorship.entry.contributionType | extensible | ArtifactContributionType |
Citation.citedArtifact.contributorship.entry.role | extensible | ContributorRole |
Citation.citedArtifact.contributorship.entry.contributionInstance.type | extensible | ArtifactContributionInstanceType |
Citation.citedArtifact.contributorship.summary.type | extensible | ContributorSummaryType |
Citation.citedArtifact.contributorship.summary.style | extensible | ContributorSummaryStyle |
Citation.citedArtifact.contributorship.summary.source | extensible | ContributorSummarySource |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Citation | Name 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-1 | warning | Citation.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Citation
Summary
Mandatory: 0 element (7 nested mandatory elements)
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron