Implementation Guide CH VACD
2.0.0 - STU 2

This page is part of the CH VACD (R4) (v2.0.0: STU 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CH VACD Recommendation Pregnancy Profile

Defining URL:http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-pregnancy
Version:2.0.0
Name:CHVACDRecommendationPregnancy
Title:CH VACD Recommendation Pregnancy Profile
Status:Draft as of 2022-02-11 02:45:16+0100
Definition:

Definition of the pregnancy part for immunization recommendation request and response documents.

Publisher:HL7 Switzerland
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-pregnancy

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CHVACDRecommendationCondition

Summary

Mandatory: 2 elements

Slices

This structure defines the following Slices:

  • The element Condition.onset[x] is sliced based on the value of type:$this

This structure is derived from CHVACDRecommendationCondition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..*CHVACDRecommendationConditionCH VACD Pregnancy Condition
... code 1..1CodeableConceptCondition code
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 11779-6
..... display1..1stringRepresentation defined by the system
Fixed Value: Delivery date Estimated from last menstrual period
... Slices for onset[x] 1..1dateTimeEstimated or actual date, date-time, or age
Slice: Unordered, Open by type:$this
... onsetDateTime 1..1dateTimeCondition onset DateTime

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*CHVACDRecommendationConditionCH VACD Pregnancy Condition
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ch-vacd-ext-cross-reference 0..1(Complex)Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-cross-reference
... ch-vacd-ext-merging-conflict-entry-reference 0..*(Complex)Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this condition
... clinicalStatus ?!ΣI0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... verificationStatus ?!ΣI0..1CodeableConceptunconfirmed | 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 0..*CodeableConceptproblem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... severity 0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.

... code Σ1..1CodeableConceptCondition code
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 11779-6
..... display1..1stringRepresentation defined by the system
Fixed Value: Delivery date Estimated from last menstrual period
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... bodySite Σ0..*CodeableConceptAnatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... subject Σ1..1Reference(CH VACD Recommendation Patient Profile)Patient
... Slices for onset[x] Σ1..1dateTimeEstimated or actual date, date-time, or age
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime Σ1..1dateTimeCondition onset DateTime
... abatement[x] I0..1When in resolution/remission
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
.... abatementStringstring
... recordedDate Σ1..1dateTimeCondition recordedDate
... recorder Σ0..1Reference(CH VACD Recommendation PractitionerRole Profile | CH VACD Recommendation Patient Profile | RelatedPerson)Who recorded the condition
... asserter Σ0..1Reference(CH VACD Recommendation PractitionerRole Profile)Person who asserts this condition
... stage I0..*BackboneElementStage/grade, usually assessed formally
con-1: Stage SHALL have summary or assessment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... summary I0..1CodeableConceptSimple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).

.... assessment I0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
.... type 0..1CodeableConceptKind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).

... evidence I0..*BackboneElementSupporting evidence
con-2: evidence SHALL have code or details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI0..*CodeableConceptManifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.


.... detail ΣI0..*Reference(Resource)Supporting information found elsewhere
... note 0..*AnnotationAdditional information about the Condition

doco Documentation for this format

This structure is derived from CHVACDRecommendationCondition

Summary

Mandatory: 2 elements

Slices

This structure defines the following Slices:

  • The element Condition.onset[x] is sliced based on the value of type:$this

Differential View

This structure is derived from CHVACDRecommendationCondition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..*CHVACDRecommendationConditionCH VACD Pregnancy Condition
... code 1..1CodeableConceptCondition code
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 11779-6
..... display1..1stringRepresentation defined by the system
Fixed Value: Delivery date Estimated from last menstrual period
... Slices for onset[x] 1..1dateTimeEstimated or actual date, date-time, or age
Slice: Unordered, Open by type:$this
... onsetDateTime 1..1dateTimeCondition onset DateTime

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*CHVACDRecommendationConditionCH VACD Pregnancy Condition
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ch-vacd-ext-cross-reference 0..1(Complex)Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-cross-reference
... ch-vacd-ext-merging-conflict-entry-reference 0..*(Complex)Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this condition
... clinicalStatus ?!ΣI0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... verificationStatus ?!ΣI0..1CodeableConceptunconfirmed | 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 0..*CodeableConceptproblem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... severity 0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.

... code Σ1..1CodeableConceptCondition code
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 11779-6
..... display1..1stringRepresentation defined by the system
Fixed Value: Delivery date Estimated from last menstrual period
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... bodySite Σ0..*CodeableConceptAnatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... subject Σ1..1Reference(CH VACD Recommendation Patient Profile)Patient
... Slices for onset[x] Σ1..1dateTimeEstimated or actual date, date-time, or age
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime Σ1..1dateTimeCondition onset DateTime
... abatement[x] I0..1When in resolution/remission
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
.... abatementStringstring
... recordedDate Σ1..1dateTimeCondition recordedDate
... recorder Σ0..1Reference(CH VACD Recommendation PractitionerRole Profile | CH VACD Recommendation Patient Profile | RelatedPerson)Who recorded the condition
... asserter Σ0..1Reference(CH VACD Recommendation PractitionerRole Profile)Person who asserts this condition
... stage I0..*BackboneElementStage/grade, usually assessed formally
con-1: Stage SHALL have summary or assessment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... summary I0..1CodeableConceptSimple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).

.... assessment I0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
.... type 0..1CodeableConceptKind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).

... evidence I0..*BackboneElementSupporting evidence
con-2: evidence SHALL have code or details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣI0..*CodeableConceptManifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.


.... detail ΣI0..*Reference(Resource)Supporting information found elsewhere
... note 0..*AnnotationAdditional information about the Condition

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Condition.languagepreferredCommonLanguages
Max Binding: AllLanguages
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
Condition.verificationStatusrequiredConditionVerificationStatus
Condition.categoryextensibleConditionCategoryCodes
Condition.severitypreferredCondition/DiagnosisSeverity
Condition.codeexamplePattern: LOINC code 11779-6("Delivery date Estimated from last menstrual period")
Condition.bodySiteexampleSNOMEDCTBodyStructures
Condition.stage.summaryexampleConditionStage
Condition.stage.typeexampleConditionStageType
Condition.evidence.codeexampleManifestationAndSymptomCodes

Constraints

IdGradePathDetailsRequirements
con-3Best PracticeConditionCondition.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-4errorConditionIf 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-5errorConditionCondition.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-2errorConditionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConditionIf 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-4errorConditionIf 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-5errorConditionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeConditionA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorCondition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCondition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCondition.extension:relatesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCondition.extension:relatesToMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCondition.extension:conflictAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCondition.extension:conflictMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCondition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCondition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCondition.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.clinicalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.verificationStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.severityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.onset[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.onset[x]:onsetDateTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.abatement[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.recordedDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.recorderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.asserterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
con-1errorCondition.stageStage SHALL have summary or assessment
: summary.exists() or assessment.exists()
ele-1errorCondition.stageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.stage.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCondition.stage.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCondition.stage.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCondition.stage.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCondition.stage.summaryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.stage.assessmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.stage.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
con-2errorCondition.evidenceevidence SHALL have code or details
: code.exists() or detail.exists()
ele-1errorCondition.evidenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.evidence.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCondition.evidence.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCondition.evidence.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCondition.evidence.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCondition.evidence.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.evidence.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCondition.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())