Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.29 CanonicalResource Resource

http://www.hl7.org/Special/committees/fiwg/index.cfmMaturity Level: N Normative (from v4.2.0) Compartments: Not linked to any defined compartments
This page has been approved as part of an ANSI standard. See the Infrastructure Package for further details.

2.29.1 Scope and Usage

The CanonicalResource represents resources that have a canonical URL:

  • They have a canonical URL (note: all resources with a canonical URL are specializations of this type)
  • They have version, status, and data properties to help manage their publication
  • They carry some additional metadata about their use, including copyright information

As an interface, this type is never created directly - see Resource Interfaces for more details.

2.29.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CanonicalResource «A»NDomainResourceCommon Ancestor declaration for definitional resources
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the {{title}}
... version Σ0..1stringBusiness version of the {{title}}
... title Σ0..1stringName for this {{title}} (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the {{title}}
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for {{title}} (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this {{title}} is defined
... copyright 0..1markdownUse and/or publishing restrictions

doco Documentation for this format

UML Diagram (Legend)

CanonicalResource (DomainResource) «Interface»An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the {{title}}title : string [0..1]The status of this {{title}}. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the {{title}} was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changesdate : dateTime [0..1]The name of the organization or individual that published the {{title}}publisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the {{title}} from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}} instancesuseContext : UsageContext [0..*]A legal or geographic region in which the {{title}} is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this {{title}} is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}copyright : markdown [0..1]

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:[name];
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

 # from Element: Element.extension
  fhir:CanonicalResource.url [ uri ]; # 0..1 Canonical identifier for this {{title}}, represented as a URI (globally unique)
  fhir:CanonicalResource.identifier [ Identifier ], ... ; # 0..* Additional identifier for the {{title}}
  fhir:CanonicalResource.version [ string ]; # 0..1 Business version of the {{title}}
  fhir:CanonicalResource.name [ string ]; # 0..1 Name for this {{title}} (computer friendly)
  fhir:CanonicalResource.title [ string ]; # 0..1 Name for this {{title}} (human friendly)
  fhir:CanonicalResource.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:CanonicalResource.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:CanonicalResource.date [ dateTime ]; # 0..1 Date last changed
  fhir:CanonicalResource.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:CanonicalResource.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:CanonicalResource.description [ markdown ]; # 0..1 Natural language description of the {{title}}
  fhir:CanonicalResource.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:CanonicalResource.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for {{title}} (if applicable)
  fhir:CanonicalResource.purpose [ markdown ]; # 0..1 Why this {{title}} is defined
  fhir:CanonicalResource.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
]

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CanonicalResource «A»NDomainResourceCommon Ancestor declaration for definitional resources
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the {{title}}
... version Σ0..1stringBusiness version of the {{title}}
... title Σ0..1stringName for this {{title}} (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the {{title}}
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for {{title}} (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this {{title}} is defined
... copyright 0..1markdownUse and/or publishing restrictions

doco Documentation for this format

UML Diagram (Legend)

CanonicalResource (DomainResource) «Interface»An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the {{title}}title : string [0..1]The status of this {{title}}. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the {{title}} was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changesdate : dateTime [0..1]The name of the organization or individual that published the {{title}}publisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the {{title}} from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}} instancesuseContext : UsageContext [0..*]A legal or geographic region in which the {{title}} is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this {{title}} is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}copyright : markdown [0..1]

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:[name];
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

 # from Element: Element.extension
  fhir:CanonicalResource.url [ uri ]; # 0..1 Canonical identifier for this {{title}}, represented as a URI (globally unique)
  fhir:CanonicalResource.identifier [ Identifier ], ... ; # 0..* Additional identifier for the {{title}}
  fhir:CanonicalResource.version [ string ]; # 0..1 Business version of the {{title}}
  fhir:CanonicalResource.name [ string ]; # 0..1 Name for this {{title}} (computer friendly)
  fhir:CanonicalResource.title [ string ]; # 0..1 Name for this {{title}} (human friendly)
  fhir:CanonicalResource.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:CanonicalResource.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:CanonicalResource.date [ dateTime ]; # 0..1 Date last changed
  fhir:CanonicalResource.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:CanonicalResource.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:CanonicalResource.description [ markdown ]; # 0..1 Natural language description of the {{title}}
  fhir:CanonicalResource.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:CanonicalResource.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for {{title}} (if applicable)
  fhir:CanonicalResource.purpose [ markdown ]; # 0..1 Why this {{title}} is defined
  fhir:CanonicalResource.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
]

2.29.3.1 Terminology Bindings

PathDefinitionTypeReference
CanonicalResource.status RequiredPublicationStatus
CanonicalResource.jurisdiction ExtensibleJurisdiction ValueSet

2.29.3.2 Constraints

idLevelLocationDescriptionExpression
cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')

2.29.4 Search Parameters

Common search parameters defined by this resource. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
contexttokenA use context assigned to the {{title}}{{name}}.useContext.valueCodeableConcept
context-quantityquantityA quantity- or range-valued use context assigned to the {{title}}{{name}}.useContext.valueQuantity, {{name}}.useContext.valueRange
context-typetokenA type of use context assigned to the {{title}}{{name}}.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the {{title}}
context-type-valuecompositeA use context type and value assigned to the {{title}}
datedateThe {{title}} publication date{{name}}.date
descriptionstringThe description of the {{title}}{{name}}.description
identifiertokenExternal identifier for the {{title}}{{name}}.identifier
jurisdictiontokenIntended jurisdiction for the {{title}}{{name}}.jurisdiction
namestringComputationally friendly name of the {{title}}{{name}}.name
publisherstringName of the publisher of the {{title}}{{name}}.publisher
statustokenThe current status of the {{title}}{{name}}.status
titlestringThe human-friendly name of the {{title}}{{name}}.title
urluriThe uri that identifies the {{title}}{{name}}.url
versiontokenThe business version of the {{title}}{{name}}.version