v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)

v2+ Details - Local Development build (v0.3.2). See the Directory of published versions

Logical Model: CER - Detailed Descriptions

Draft as of 2023-08-09

Definitions for the CER logical model.

Guidance on how to interpret the contents of this table can be found here

0. CER
Definition

Certificate Detail

Control1..1
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CER.setID-CER
Definition

Set ID - CER

ShortsetID-CER
Control1..1
TypeSI
Must Supporttrue
Max Length4
4. CER.serialNumber
Definition

Serial Number

ShortserialNumber
Control0..1
TypeST
6. CER.version
Definition

Version

Shortversion
NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
TypeST
8. CER.grantingAuthority
Definition

Granting Authority

ShortgrantingAuthority
Control0..1
TypeXON
10. CER.issuingAuthority
Definition

Issuing Authority

ShortissuingAuthority
Control0..1
TypeXCN
12. CER.signature
Definition

Signature

Shortsignature
Control0..1
TypeED
14. CER.grantingCountry
Definition

Granting Country

ShortgrantingCountry
Control0..1
TypeID
Max Length3
16. CER.grantingStateProvince
Definition

Granting StateProvince

ShortgrantingStateProvince
Control0..1
TypeCWE
18. CER.grantingCountyParish
Definition

Granting CountyParish

ShortgrantingCountyParish
Control0..1
TypeCWE
20. CER.certificateType
Definition

Certificate Type

ShortcertificateType
Control0..1
TypeCWE
22. CER.certificateDomain
Definition

Certificate Domain

ShortcertificateDomain
Control0..1
TypeCWE
24. CER.subjectID
Definition

Subject ID

ShortsubjectID
Control0..1
TypeEI
26. CER.subjectName
Definition

Subject Name

ShortsubjectName
Control1..1
TypeST
Must Supporttrue
28. CER.subjectDirectoryAttributeExtension
Definition

Subject Directory Attribute Extension

ShortsubjectDirectoryAttributeExtension
Control0..*
TypeCWE
30. CER.subjectPublicKeyInfo
Definition

Subject Public Key Info

ShortsubjectPublicKeyInfo
Control0..1
TypeCWE
32. CER.authorityKeyIdentifier
Definition

Authority Key Identifier

ShortauthorityKeyIdentifier
Control0..1
TypeCWE
34. CER.basicConstraint
Definition

Basic Constraint

ShortbasicConstraint
Control0..1
TypeID
Max Length1
36. CER.cRLDistributionPoint
Definition

CRL Distribution Point

ShortcRLDistributionPoint
Control0..*
TypeCWE
38. CER.jurisdictionCountry
Definition

Jurisdiction Country

ShortjurisdictionCountry
Control0..1
TypeID
Max Length3
40. CER.jurisdictionStateProvince
Definition

Jurisdiction StateProvince

ShortjurisdictionStateProvince
Control0..1
TypeCWE
42. CER.jurisdictionCountyParish
Definition

Jurisdiction CountyParish

ShortjurisdictionCountyParish
Control0..1
TypeCWE
44. CER.jurisdictionBreadth
Definition

Jurisdiction Breadth

ShortjurisdictionBreadth
Control0..*
TypeCWE
46. CER.grantingDate
Definition

Granting Date

ShortgrantingDate
Control0..1
TypeDTM
48. CER.issuingDate
Definition

Issuing Date

ShortissuingDate
Control0..1
TypeDTM
50. CER.activationDate
Definition

Activation Date

ShortactivationDate
Control0..1
TypeDTM
52. CER.inactivationDate
Definition

Inactivation Date

ShortinactivationDate
Control0..1
TypeDTM
54. CER.expirationDate
Definition

Expiration Date

ShortexpirationDate
Control0..1
TypeDTM
56. CER.renewalDate
Definition

Renewal Date

ShortrenewalDate
Control0..1
TypeDTM
58. CER.revocationDate
Definition

Revocation Date

ShortrevocationDate
Control0..1
TypeDTM
60. CER.revocationReasonCode
Definition

Revocation Reason Code

ShortrevocationReasonCode
Control0..1
TypeCWE
62. CER.certificateStatusCode
Definition

Certificate Status Code

ShortcertificateStatusCode
Control0..1
TypeCWE

Guidance on how to interpret the contents of this table can be found here

0. CER
Definition

Certificate Detail


A resource that includes narrative, extensions, and contained resources.

ShortA resource with narrative, extensions, and contained resources
Control10..1*
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. CER.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. CER.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. CER.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CER.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
8. CER.setID-CER
Definition

Set ID - CER

ShortsetID-CER
Control1..1
TypeSI
Must Supporttrue
Max Length4
10. CER.serialNumber
Definition

Serial Number

ShortserialNumber
Control0..1
TypeST
12. CER.version
Definition

Version

Shortversion
NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
TypeST
14. CER.grantingAuthority
Definition

Granting Authority

ShortgrantingAuthority
Control0..1
TypeXON
16. CER.issuingAuthority
Definition

Issuing Authority

ShortissuingAuthority
Control0..1
TypeXCN
18. CER.signature
Definition

Signature

Shortsignature
Control0..1
TypeED
20. CER.grantingCountry
Definition

Granting Country

ShortgrantingCountry
Control0..1
TypeID
Max Length3
22. CER.grantingStateProvince
Definition

Granting StateProvince

ShortgrantingStateProvince
Control0..1
TypeCWE
24. CER.grantingCountyParish
Definition

Granting CountyParish

ShortgrantingCountyParish
Control0..1
TypeCWE
26. CER.certificateType
Definition

Certificate Type

ShortcertificateType
Control0..1
TypeCWE
28. CER.certificateDomain
Definition

Certificate Domain

ShortcertificateDomain
Control0..1
TypeCWE
30. CER.subjectID
Definition

Subject ID

ShortsubjectID
Control0..1
TypeEI
32. CER.subjectName
Definition

Subject Name

ShortsubjectName
Control1..1
TypeST
Must Supporttrue
34. CER.subjectDirectoryAttributeExtension
Definition

Subject Directory Attribute Extension

ShortsubjectDirectoryAttributeExtension
Control0..*
TypeCWE
36. CER.subjectPublicKeyInfo
Definition

Subject Public Key Info

ShortsubjectPublicKeyInfo
Control0..1
TypeCWE
38. CER.authorityKeyIdentifier
Definition

Authority Key Identifier

ShortauthorityKeyIdentifier
Control0..1
TypeCWE
40. CER.basicConstraint
Definition

Basic Constraint

ShortbasicConstraint
Control0..1
TypeID
Max Length1
42. CER.cRLDistributionPoint
Definition

CRL Distribution Point

ShortcRLDistributionPoint
Control0..*
TypeCWE
44. CER.jurisdictionCountry
Definition

Jurisdiction Country

ShortjurisdictionCountry
Control0..1
TypeID
Max Length3
46. CER.jurisdictionStateProvince
Definition

Jurisdiction StateProvince

ShortjurisdictionStateProvince
Control0..1
TypeCWE
48. CER.jurisdictionCountyParish
Definition

Jurisdiction CountyParish

ShortjurisdictionCountyParish
Control0..1
TypeCWE
50. CER.jurisdictionBreadth
Definition

Jurisdiction Breadth

ShortjurisdictionBreadth
Control0..*
TypeCWE
52. CER.grantingDate
Definition

Granting Date

ShortgrantingDate
Control0..1
TypeDTM
54. CER.issuingDate
Definition

Issuing Date

ShortissuingDate
Control0..1
TypeDTM
56. CER.activationDate
Definition

Activation Date

ShortactivationDate
Control0..1
TypeDTM
58. CER.inactivationDate
Definition

Inactivation Date

ShortinactivationDate
Control0..1
TypeDTM
60. CER.expirationDate
Definition

Expiration Date

ShortexpirationDate
Control0..1
TypeDTM
62. CER.renewalDate
Definition

Renewal Date

ShortrenewalDate
Control0..1
TypeDTM
64. CER.revocationDate
Definition

Revocation Date

ShortrevocationDate
Control0..1
TypeDTM
66. CER.revocationReasonCode
Definition

Revocation Reason Code

ShortrevocationReasonCode
Control0..1
TypeCWE
68. CER.certificateStatusCode
Definition

Certificate Status Code

ShortcertificateStatusCode
Control0..1
TypeCWE

Guidance on how to interpret the contents of this table can be found here

0. CER
Definition

Certificate Detail

ShortA resource with narrative, extensions, and contained resources
Control1..1
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. CER.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. CER.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. CER.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. CER.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguages: IETF language tag for a human language
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. CER.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. CER.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. CER.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CER.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
16. CER.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CER.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
18. CER.setID-CER
Definition

Set ID - CER

ShortsetID-CER
Control1..1
TypeSI
Must Supporttrue
Max Length4
20. CER.serialNumber
Definition

Serial Number

ShortserialNumber
Control0..1
TypeST
22. CER.version
Definition

Version

Shortversion
NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
TypeST
24. CER.grantingAuthority
Definition

Granting Authority

ShortgrantingAuthority
Control0..1
TypeXON
26. CER.issuingAuthority
Definition

Issuing Authority

ShortissuingAuthority
Control0..1
TypeXCN
28. CER.signature
Definition

Signature

Shortsignature
Control0..1
TypeED
30. CER.grantingCountry
Definition

Granting Country

ShortgrantingCountry
Control0..1
TypeID
Max Length3
32. CER.grantingStateProvince
Definition

Granting StateProvince

ShortgrantingStateProvince
Control0..1
TypeCWE
34. CER.grantingCountyParish
Definition

Granting CountyParish

ShortgrantingCountyParish
Control0..1
TypeCWE
36. CER.certificateType
Definition

Certificate Type

ShortcertificateType
Control0..1
TypeCWE
38. CER.certificateDomain
Definition

Certificate Domain

ShortcertificateDomain
Control0..1
TypeCWE
40. CER.subjectID
Definition

Subject ID

ShortsubjectID
Control0..1
TypeEI
42. CER.subjectName
Definition

Subject Name

ShortsubjectName
Control1..1
TypeST
Must Supporttrue
44. CER.subjectDirectoryAttributeExtension
Definition

Subject Directory Attribute Extension

ShortsubjectDirectoryAttributeExtension
Control0..*
TypeCWE
46. CER.subjectPublicKeyInfo
Definition

Subject Public Key Info

ShortsubjectPublicKeyInfo
Control0..1
TypeCWE
48. CER.authorityKeyIdentifier
Definition

Authority Key Identifier

ShortauthorityKeyIdentifier
Control0..1
TypeCWE
50. CER.basicConstraint
Definition

Basic Constraint

ShortbasicConstraint
Control0..1
TypeID
Max Length1
52. CER.cRLDistributionPoint
Definition

CRL Distribution Point

ShortcRLDistributionPoint
Control0..*
TypeCWE
54. CER.jurisdictionCountry
Definition

Jurisdiction Country

ShortjurisdictionCountry
Control0..1
TypeID
Max Length3
56. CER.jurisdictionStateProvince
Definition

Jurisdiction StateProvince

ShortjurisdictionStateProvince
Control0..1
TypeCWE
58. CER.jurisdictionCountyParish
Definition

Jurisdiction CountyParish

ShortjurisdictionCountyParish
Control0..1
TypeCWE
60. CER.jurisdictionBreadth
Definition

Jurisdiction Breadth

ShortjurisdictionBreadth
Control0..*
TypeCWE
62. CER.grantingDate
Definition

Granting Date

ShortgrantingDate
Control0..1
TypeDTM
64. CER.issuingDate
Definition

Issuing Date

ShortissuingDate
Control0..1
TypeDTM
66. CER.activationDate
Definition

Activation Date

ShortactivationDate
Control0..1
TypeDTM
68. CER.inactivationDate
Definition

Inactivation Date

ShortinactivationDate
Control0..1
TypeDTM
70. CER.expirationDate
Definition

Expiration Date

ShortexpirationDate
Control0..1
TypeDTM
72. CER.renewalDate
Definition

Renewal Date

ShortrenewalDate
Control0..1
TypeDTM
74. CER.revocationDate
Definition

Revocation Date

ShortrevocationDate
Control0..1
TypeDTM
76. CER.revocationReasonCode
Definition

Revocation Reason Code

ShortrevocationReasonCode
Control0..1
TypeCWE
78. CER.certificateStatusCode
Definition

Certificate Status Code

ShortcertificateStatusCode
Control0..1
TypeCWE