Current Build

​ D.4.1 StructureDefinition: fpar-contraceptiveChoiceAtExit

​D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptiveChoiceAtExit

This profile builds on US Core Results Profile.

This profile was published on Thu May 18 00:00:00 EDT 2017 as a draft by Healthcare Services Platform Consortium on belhalf of FPAR.

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

This structure is derived from US Core Results Profile

Summary

Must-Support: 1 element
Prohibited: 7 elements

Extensions

This structure refers to these extensions:

  • Unable to summarise extension http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod (no extension found)

This structure is derived from US Core Results Profile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation IFPAR Contraceptive Choice At Exit.
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... extension 0..1?? [CanonicalType[http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod]]​FPAR Contraception Provision Method
URL: http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod
Binding: FPAR Contraception Provision Methods value set (preferred)
... code
... valueCodeableConcept 0..1CodeableConceptBinding: FPAR Contraceptive Choice value set (preferred)
... bodySite 0..0
... dataAbsentReason S0..1CodeableConceptBinding: FPAR Reason No Contraceptive Chosen value set (extensible)
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... related 0..0
... component 0..0

doco Documentation for this format

This structure is derived from US Core Results Profile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*FPAR Contraceptive Choice At Exit profile.
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... extension 0..1?? [CanonicalType[http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod]]​FPAR Contraception Provision Method
URL: http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod
Binding: FPAR Contraception Provision Methods value set (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)Fulfills plan, proposal or order
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category SI1..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
us-core-5: Must have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category'
... code SΣ1..1CodeableConceptLaboratory Test Name
... subject SΣ1..1​Reference(FPAR Patient Profile)Who and/or what this is about
... context 0..1Reference(Encounter | EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] SΣI0..1dateTime, PeriodClinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference()Who is responsible for the observation
... valueCodeableConcept SΣ0..1CodeableConceptA coded result
Binding: FPAR Contraceptive Choice value set (preferred)
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: FPAR Reason No Contraceptive Chosen value set (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
... comment 0..1stringComments about result

doco Documentation for this format

This structure is derived from US Core Results Profile

Summary

Must-Support: 1 element
Prohibited: 7 elements

Extensions

This structure refers to these extensions:

  • Unable to summarise extension http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod (no extension found)

Differential View

This structure is derived from US Core Results Profile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation IFPAR Contraceptive Choice At Exit.
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... extension 0..1?? [CanonicalType[http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod]]​FPAR Contraception Provision Method
URL: http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod
Binding: FPAR Contraception Provision Methods value set (preferred)
... code
... valueCodeableConcept 0..1CodeableConceptBinding: FPAR Contraceptive Choice value set (preferred)
... bodySite 0..0
... dataAbsentReason S0..1CodeableConceptBinding: FPAR Reason No Contraceptive Chosen value set (extensible)
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... related 0..0
... component 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*FPAR Contraceptive Choice At Exit profile.
us-core-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... extension 0..1?? [CanonicalType[http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod]]​FPAR Contraception Provision Method
URL: http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod
Binding: FPAR Contraception Provision Methods value set (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)Fulfills plan, proposal or order
... status ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category SI1..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
us-core-5: Must have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category'
... code SΣ1..1CodeableConceptLaboratory Test Name
... subject SΣ1..1​Reference(FPAR Patient Profile)Who and/or what this is about
... context 0..1Reference(Encounter | EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] SΣI0..1dateTime, PeriodClinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference()Who is responsible for the observation
... valueCodeableConcept SΣ0..1CodeableConceptA coded result
Binding: FPAR Contraceptive Choice value set (preferred)
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: FPAR Reason No Contraceptive Chosen value set (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
... comment 0..1stringComments about result

doco Documentation for this format

 

​D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Observation.languageCommon LanguagesextensibleCommon Languages
Observation.extension
[CanonicalType[http://hl7.org/fhir/fpar/StructureDefinition/fpar-contraceptionProvisionMethod]]		FPAR Contraception Provision Methods value setpreferred​FPAR Contraception Provision Methods value set
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodespreferredObservation Category Codes
Observation.valueCodeableConceptFPAR Contraceptive Choice value setpreferredFPAR Contraceptive Choice value set
Observation.dataAbsentReasonFPAR Reason No Contraceptive Chosen value setextensibleFPAR Reason No Contraceptive Chosen value set
Observation.referenceRange.typeObservation Reference Range Meaning CodesextensibleObservation Reference Range Meaning Codes
Observation.referenceRange.appliesToObservation Reference Range Applies To CodesexampleObservation Reference Range Applies To Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.component.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes

​D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ObservationIf 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-3ObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
obs-7ObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
: value.empty() or code!=component.code
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
us-core-2ObservationIf there is no component or related element then either a value[x] or a data absent reason must be present
: (component.empty() and related.empty()) implies (dataAbsentReason or value)
us-core-5Observation.categoryMust have a category of 'laboratory' and a code system 'http://hl7.org/fhir/observation-category'
: where(coding.system='http://hl7.org/fhir/observation-category' and coding.code='laboratory').exists()
us-core-1Observation.effective[x]Datetime must be at least to day.
: ($this as dateTime).toString().length() >= 8
.