Implementation Guide CH VACD
5.0.0 - trial-use
This page is part of the CH VACD (R4) (v5.0.0: STU 5) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-basic-immunization | Version: 5.0.0 | |||
Draft as of 2024-12-18 | Computable Name: CHVACDBasicImmunization | |||
Copyright/Legal: CC0-1.0 |
Condition to declare Basic Immunization done by one single condition for DTPa or Polio. This is for cases the patient does not have a vaccination certificate to declare it, but knows that it is done.
There are cases where it is not possible to enter all given vaccinations because of lack of documentation (i.e. loss of vaccination card) but it's known, that the person is vaccinatied in childhood according to the common immunization program to reach basic immunization.
With this profile, this information can be documented in the electronic records. Clinical decision systems can based on this information make correct recommendations.
The corresponding value set with the possible codes can be found here
By aggregation of different Immunization Administration documents, dupplicates could be detected. If so, the entries in the Vaccination Record document (as result of the aggregation) should be completed with the extension CH VACD Extension Merging Conflict Entry Reference. The criterias of duplicate detection can be found here.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHVACDCondition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | 0..* | CHVACDCondition | CH VACD Basic Immunization Conditions | |
category | 1..1 | CodeableConcept | Encounter Diagnosis Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |
code | 1..1 | CodeableConcept | Basic immunization code Binding: Basic Immunization Codes (extensible): The code declaring the status of basi immunization for DTPa and/or Polio. | |
Slices for onset[x] | 1..1 | dateTime | Estimated or actual date, date-time, or age Slice: Unordered, Open by type:$this | |
onset[x]:onsetDateTime | 1..1 | dateTime | Condition onset DateTime to declare the date where the basic immunization is declared as done. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.code | extensible | BasicImmunizationCodehttp://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-basic-immunization-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | CHVACDCondition | CH VACD Basic Immunization Conditions con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
Slices for extension | Content/Rules for all slices | |||||||
relatesTo | S | 0..1 | (Complex) | Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
conflict | S | 0..* | (Complex) | Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
identifier | Σ | 1..* | Identifier | External Ids for this condition ele-1: All FHIR elements must have a @value or children | ||||
clinicalStatus | ?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. ele-1: All FHIR elements must have a @value or children | ||||
verificationStatus | ?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. ele-1: All FHIR elements must have a @value or children | ||||
category | 1..1 | CodeableConcept | Encounter Diagnosis Binding: ConditionCategoryCodes (extensible)
ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |||||
code | SΣ | 1..1 | CodeableConcept | Basic immunization code Binding: Basic Immunization Codes (extensible): The code declaring the status of basi immunization for DTPa and/or Polio.
ele-1: All FHIR elements must have a @value or children | ||||
subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient ele-1: All FHIR elements must have a @value or children | ||||
Slices for onset[x] | Σ | 1..1 | dateTime | Estimated or actual date, date-time, or age Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | ||||
onset[x]:onsetDateTime | Σ | 1..1 | dateTime | Condition onset DateTime to declare the date where the basic immunization is declared as done. ele-1: All FHIR elements must have a @value or children | ||||
recordedDate | SΣ | 1..1 | dateTime | Condition recordedDate ele-1: All FHIR elements must have a @value or children | ||||
recorder | SΣ | 0..1 | Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Who recorded the condition ele-1: All FHIR elements must have a @value or children | ||||
asserter | SΣ | 0..1 | Reference(CH Core PractitionerRole) | Person who asserts this condition ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard | |
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard | |
Condition.category | extensible | Pattern: encounter-diagnosishttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | |
Condition.code | extensible | BasicImmunizationCodehttp://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-basic-immunization-vs from this IG |
Id | Grade | Path(s) | Details | Requirements |
con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Condition | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Condition | 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 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
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 | ||||
---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | CHVACDCondition | CH VACD Basic Immunization Conditions con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
relatesTo | S | 0..1 | (Complex) | Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references | ||||
conflict | S | 0..* | (Complex) | Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | External Ids for this condition | ||||
clinicalStatus | ?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. | ||||
verificationStatus | ?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. | ||||
category | 1..1 | CodeableConcept | Encounter Diagnosis Binding: ConditionCategoryCodes (extensible)
Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://terminology.hl7.org/CodeSystem/condition-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
severity | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician. | |||||
code | SΣ | 1..1 | CodeableConcept | Basic immunization code Binding: Basic Immunization Codes (extensible): The code declaring the status of basi immunization for DTPa and/or Polio.
| ||||
bodySite | Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient | ||||
encounter | Σ | 0..1 | Reference(CH Core Encounter) | Encounter created as part of | ||||
Slices for onset[x] | Σ | 1..1 | dateTime | Estimated or actual date, date-time, or age Slice: Unordered, Closed by type:$this | ||||
onset[x]:onsetDateTime | Σ | 1..1 | dateTime | Condition onset DateTime to declare the date where the basic immunization is declared as done. | ||||
abatement[x] | C | 0..1 | When in resolution/remission | |||||
abatementDateTime | dateTime | |||||||
abatementAge | Age | |||||||
abatementPeriod | Period | |||||||
abatementRange | Range | |||||||
abatementString | string | |||||||
recordedDate | SΣ | 1..1 | dateTime | Condition recordedDate | ||||
recorder | SΣ | 0..1 | Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Who recorded the condition | ||||
asserter | SΣ | 0..1 | Reference(CH Core PractitionerRole) | Person who asserts this condition | ||||
stage | C | 0..* | BackboneElement | Stage/grade, usually assessed formally con-1: Stage SHALL have summary or assessment | ||||
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 | ||||
summary | C | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||
assessment | C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | ||||
type | 0..1 | CodeableConcept | Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological). | |||||
evidence | C | 0..* | BackboneElement | Supporting evidence con-2: evidence SHALL have code or details | ||||
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 | ||||
code | ΣC | 0..* | CodeableConcept | Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition. | ||||
detail | ΣC | 0..* | Reference(Resource) | Supporting information found elsewhere | ||||
note | 0..* | Annotation | Additional information about the Condition | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Reference(CH Core Practitioner | CH Core Patient | RelatedPerson | CH Core Organization) | Individual responsible for the annotation | ||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Condition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard | ||||
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard | ||||
Condition.category | extensible | Pattern: encounter-diagnosishttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | ||||
Condition.severity | preferred | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | ||||
Condition.code | extensible | BasicImmunizationCodehttp://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-basic-immunization-vs from this IG | ||||
Condition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Condition.stage.summary | example | ConditionStagehttp://hl7.org/fhir/ValueSet/condition-stage from the FHIR Standard | ||||
Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard | ||||
Condition.evidence.code | example | ManifestationAndSymptomCodeshttp://hl7.org/fhir/ValueSet/manifestation-or-symptom from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
con-1 | error | Condition.stage | Stage SHALL have summary or assessment : summary.exists() or assessment.exists() | |
con-2 | error | Condition.evidence | evidence SHALL have code or details : code.exists() or detail.exists() | |
con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Condition | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Condition | 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 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
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 CHVACDCondition
Summary
Mandatory: 3 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CHVACDCondition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | 0..* | CHVACDCondition | CH VACD Basic Immunization Conditions | |
category | 1..1 | CodeableConcept | Encounter Diagnosis Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |
code | 1..1 | CodeableConcept | Basic immunization code Binding: Basic Immunization Codes (extensible): The code declaring the status of basi immunization for DTPa and/or Polio. | |
Slices for onset[x] | 1..1 | dateTime | Estimated or actual date, date-time, or age Slice: Unordered, Open by type:$this | |
onset[x]:onsetDateTime | 1..1 | dateTime | Condition onset DateTime to declare the date where the basic immunization is declared as done. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.code | extensible | BasicImmunizationCodehttp://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-basic-immunization-vs from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | CHVACDCondition | CH VACD Basic Immunization Conditions con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
Slices for extension | Content/Rules for all slices | |||||||
relatesTo | S | 0..1 | (Complex) | Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
conflict | S | 0..* | (Complex) | Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
identifier | Σ | 1..* | Identifier | External Ids for this condition ele-1: All FHIR elements must have a @value or children | ||||
clinicalStatus | ?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. ele-1: All FHIR elements must have a @value or children | ||||
verificationStatus | ?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. ele-1: All FHIR elements must have a @value or children | ||||
category | 1..1 | CodeableConcept | Encounter Diagnosis Binding: ConditionCategoryCodes (extensible)
ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |||||
code | SΣ | 1..1 | CodeableConcept | Basic immunization code Binding: Basic Immunization Codes (extensible): The code declaring the status of basi immunization for DTPa and/or Polio.
ele-1: All FHIR elements must have a @value or children | ||||
subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient ele-1: All FHIR elements must have a @value or children | ||||
Slices for onset[x] | Σ | 1..1 | dateTime | Estimated or actual date, date-time, or age Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | ||||
onset[x]:onsetDateTime | Σ | 1..1 | dateTime | Condition onset DateTime to declare the date where the basic immunization is declared as done. ele-1: All FHIR elements must have a @value or children | ||||
recordedDate | SΣ | 1..1 | dateTime | Condition recordedDate ele-1: All FHIR elements must have a @value or children | ||||
recorder | SΣ | 0..1 | Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Who recorded the condition ele-1: All FHIR elements must have a @value or children | ||||
asserter | SΣ | 0..1 | Reference(CH Core PractitionerRole) | Person who asserts this condition ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard | |
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard | |
Condition.category | extensible | Pattern: encounter-diagnosishttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | |
Condition.code | extensible | BasicImmunizationCodehttp://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-basic-immunization-vs from this IG |
Id | Grade | Path(s) | Details | Requirements |
con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Condition | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Condition | 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 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
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 | ||||
---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | CHVACDCondition | CH VACD Basic Immunization Conditions con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
relatesTo | S | 0..1 | (Complex) | Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references | ||||
conflict | S | 0..* | (Complex) | Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | External Ids for this condition | ||||
clinicalStatus | ?!ΣC | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis. | ||||
verificationStatus | ?!ΣC | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis. | ||||
category | 1..1 | CodeableConcept | Encounter Diagnosis Binding: ConditionCategoryCodes (extensible)
Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://terminology.hl7.org/CodeSystem/condition-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: encounter-diagnosis | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
severity | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician. | |||||
code | SΣ | 1..1 | CodeableConcept | Basic immunization code Binding: Basic Immunization Codes (extensible): The code declaring the status of basi immunization for DTPa and/or Polio.
| ||||
bodySite | Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient | ||||
encounter | Σ | 0..1 | Reference(CH Core Encounter) | Encounter created as part of | ||||
Slices for onset[x] | Σ | 1..1 | dateTime | Estimated or actual date, date-time, or age Slice: Unordered, Closed by type:$this | ||||
onset[x]:onsetDateTime | Σ | 1..1 | dateTime | Condition onset DateTime to declare the date where the basic immunization is declared as done. | ||||
abatement[x] | C | 0..1 | When in resolution/remission | |||||
abatementDateTime | dateTime | |||||||
abatementAge | Age | |||||||
abatementPeriod | Period | |||||||
abatementRange | Range | |||||||
abatementString | string | |||||||
recordedDate | SΣ | 1..1 | dateTime | Condition recordedDate | ||||
recorder | SΣ | 0..1 | Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Who recorded the condition | ||||
asserter | SΣ | 0..1 | Reference(CH Core PractitionerRole) | Person who asserts this condition | ||||
stage | C | 0..* | BackboneElement | Stage/grade, usually assessed formally con-1: Stage SHALL have summary or assessment | ||||
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 | ||||
summary | C | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages). | ||||
assessment | C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | ||||
type | 0..1 | CodeableConcept | Kind of staging Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological). | |||||
evidence | C | 0..* | BackboneElement | Supporting evidence con-2: evidence SHALL have code or details | ||||
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 | ||||
code | ΣC | 0..* | CodeableConcept | Manifestation/symptom Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition. | ||||
detail | ΣC | 0..* | Reference(Resource) | Supporting information found elsewhere | ||||
note | 0..* | Annotation | Additional information about the Condition | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Reference(CH Core Practitioner | CH Core Patient | RelatedPerson | CH Core Organization) | Individual responsible for the annotation | ||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Condition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Condition.clinicalStatus | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinical|4.0.1 from the FHIR Standard | ||||
Condition.verificationStatus | required | ConditionVerificationStatushttp://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1 from the FHIR Standard | ||||
Condition.category | extensible | Pattern: encounter-diagnosishttp://hl7.org/fhir/ValueSet/condition-category from the FHIR Standard | ||||
Condition.severity | preferred | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | ||||
Condition.code | extensible | BasicImmunizationCodehttp://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-basic-immunization-vs from this IG | ||||
Condition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Condition.stage.summary | example | ConditionStagehttp://hl7.org/fhir/ValueSet/condition-stage from the FHIR Standard | ||||
Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard | ||||
Condition.evidence.code | example | ManifestationAndSymptomCodeshttp://hl7.org/fhir/ValueSet/manifestation-or-symptom from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
con-1 | error | Condition.stage | Stage SHALL have summary or assessment : summary.exists() or assessment.exists() | |
con-2 | error | Condition.evidence | evidence SHALL have code or details : code.exists() or detail.exists() | |
con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Condition | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Condition | 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 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
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 CHVACDCondition
Summary
Mandatory: 3 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron