Current Build
The official URL for this profile is:
http://hl7.org/fhir/fpar/StructureDefinition/fpar-counselingToAchievePregnancy
This profile builds on US Core Procedure Profile.
This profile was published on Mon Aug 01 00:00:00 EDT 2016 as a draft by Healthcare Services Platform Consortium on behalf of Family Planning Annual Report.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from US Core Procedure Profile
This structure is derived from US Core Procedure Profile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Procedure | FPAR Counseling To Achieve Pregnancy Profile | |||
  status | S | 1..1 | code | Binding: EventStatus (required) |
 code | S | 1..1 | CodeableConcept | SNOMED-CT | ICD-10 | CPT-4 Binding: US Core Procedure Codes (extensible) |
 subject | S | 1..1 | Reference(US Core Patient Profile) | |
  performed[x] | S | 1..1 | dateTime, Period | |
| Documentation for this format | ||||
This structure is derived from US Core Procedure Profile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | I | 0..* | FPAR Counseling To Achieve Pregnancy Profile | |
| 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Identifiers for this procedure |
| definition | Σ | 0..* | Reference(PlanDefinition | ActivityDefinition | HealthcareService) | Instantiates protocol or definition |
| basedOn | Σ | 0..* | Reference(CarePlan | ProcedureRequest | ReferralRequest) | A request for this procedure |
| partOf | Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event |
| status | ?!SΣ | 1..1 | code | preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown Binding: EventStatus (required) |
| notDone | ?!Σ | 0..1 | boolean | True if procedure was not performed as scheduled |
| notDoneReason | ΣI | 0..1 | CodeableConcept | Reason procedure was not performed Binding: Procedure Not Performed Reason (SNOMED-CT) (example) |
| category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: Procedure Category Codes (SNOMED CT) (example) |
| code | SΣ | 1..1 | CodeableConcept | SNOMED-CT | ICD-10 | CPT-4 Binding: US Core Procedure Codes (extensible) |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the procedure was performed on |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or episode associated with the procedure |
| performed[x] | SΣ | 1..1 | dateTime, Period | Date/Period the procedure was performed |
| performer | ΣI | 0..* | BackboneElement | The people who performed the procedure |
  id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 0..1 | CodeableConcept | The role the actor was in Binding: Procedure Performer Role Codes (example) |
| actor | Σ | 1..1 | Reference(Practitioner | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner |
 onBehalfOf | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |
| location | Σ | 0..1 | Reference(Location) | Where the procedure happened |
| reasonCode | Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: Procedure Reason Codes (example) |
| reasonReference | Σ | 0..* | Reference(Condition | Observation) | Condition that is the reason the procedure performed |
| bodySite | Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMED CT Body Structures (example) |
| outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: Procedure Outcome Codes (SNOMED CT) (example) |
| report | 0..* | Reference(DiagnosticReport) | Any report resulting from the procedure | |
| complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/Diagnosis Codes (example) | |
| complicationDetail | 0..* | Reference(Condition) | A condition that is a result of the procedure | |
| followUp | 0..* | CodeableConcept | Instructions for follow up Binding: Procedure Follow up Codes (SNOMED CT) (example) | |
| note | 0..* | Annotation | Additional information about the procedure | |
| focalDevice | I | 0..* | BackboneElement | Device changed in procedure |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| action | 0..1 | CodeableConcept | Kind of change to device Binding: Procedure Device Action Codes (preferred) | |
| manipulated | 1..1 | Reference(Device) | Device that was changed | |
| usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |
| usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIR Device Types (example) | |
| Documentation for this format | ||||
This structure is derived from US Core Procedure Profile
Differential View
This structure is derived from US Core Procedure Profile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | FPAR Counseling To Achieve Pregnancy Profile | |||
| status | S | 1..1 | code | Binding: EventStatus (required) |
| code | S | 1..1 | CodeableConcept | SNOMED-CT | ICD-10 | CPT-4 Binding: US Core Procedure Codes (extensible) |
| subject | S | 1..1 | Reference(US Core Patient Profile) | |
| performed[x] | S | 1..1 | dateTime, Period | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | I | 0..* | FPAR Counseling To Achieve Pregnancy Profile | |
| 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Identifiers for this procedure |
| definition | Σ | 0..* | Reference(PlanDefinition | ActivityDefinition | HealthcareService) | Instantiates protocol or definition |
| basedOn | Σ | 0..* | Reference(CarePlan | ProcedureRequest | ReferralRequest) | A request for this procedure |
| partOf | Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event |
| status | ?!SΣ | 1..1 | code | preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown Binding: EventStatus (required) |
| notDone | ?!Σ | 0..1 | boolean | True if procedure was not performed as scheduled |
| notDoneReason | ΣI | 0..1 | CodeableConcept | Reason procedure was not performed Binding: Procedure Not Performed Reason (SNOMED-CT) (example) |
| category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: Procedure Category Codes (SNOMED CT) (example) |
| code | SΣ | 1..1 | CodeableConcept | SNOMED-CT | ICD-10 | CPT-4 Binding: US Core Procedure Codes (extensible) |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the procedure was performed on |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or episode associated with the procedure |
| performed[x] | SΣ | 1..1 | dateTime, Period | Date/Period the procedure was performed |
| performer | ΣI | 0..* | BackboneElement | The people who performed the procedure |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| role | Σ | 0..1 | CodeableConcept | The role the actor was in Binding: Procedure Performer Role Codes (example) |
| actor | Σ | 1..1 | Reference(Practitioner | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner |
| onBehalfOf | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |
| location | Σ | 0..1 | Reference(Location) | Where the procedure happened |
| reasonCode | Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: Procedure Reason Codes (example) |
| reasonReference | Σ | 0..* | Reference(Condition | Observation) | Condition that is the reason the procedure performed |
| bodySite | Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMED CT Body Structures (example) |
| outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: Procedure Outcome Codes (SNOMED CT) (example) |
| report | 0..* | Reference(DiagnosticReport) | Any report resulting from the procedure | |
| complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/Diagnosis Codes (example) | |
| complicationDetail | 0..* | Reference(Condition) | A condition that is a result of the procedure | |
| followUp | 0..* | CodeableConcept | Instructions for follow up Binding: Procedure Follow up Codes (SNOMED CT) (example) | |
| note | 0..* | Annotation | Additional information about the procedure | |
| focalDevice | I | 0..* | BackboneElement | Device changed in procedure |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| action | 0..1 | CodeableConcept | Kind of change to device Binding: Procedure Device Action Codes (preferred) | |
| manipulated | 1..1 | Reference(Device) | Device that was changed | |
| usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |
| usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIR Device Types (example) | |
| Documentation for this format | ||||
| Path | Name | Conformance | ValueSet |
| Procedure.language | Common Languages | extensible | Common Languages |
| Procedure.status | EventStatus | required | EventStatus |
| Procedure.notDoneReason | Procedure Not Performed Reason (SNOMED-CT) | example | Procedure Not Performed Reason (SNOMED-CT) |
| Procedure.category | Procedure Category Codes (SNOMED CT) | example | Procedure Category Codes (SNOMED CT) |
| Procedure.code | US Core Procedure Codes | extensible | US Core Procedure Codes |
| Procedure.performer.role | Procedure Performer Role Codes | example | Procedure Performer Role Codes |
| Procedure.reasonCode | Procedure Reason Codes | example | Procedure Reason Codes |
| Procedure.bodySite | SNOMED CT Body Structures | example | SNOMED CT Body Structures |
| Procedure.outcome | Procedure Outcome Codes (SNOMED CT) | example | Procedure Outcome Codes (SNOMED CT) |
| Procedure.complication | Condition/Problem/Diagnosis Codes | example | Condition/Problem/Diagnosis Codes |
| Procedure.followUp | Procedure Follow up Codes (SNOMED CT) | example | Procedure Follow up Codes (SNOMED CT) |
| Procedure.focalDevice.action | Procedure Device Action Codes | preferred | Procedure Device Action Codes |
| Procedure.usedCode | FHIR Device Types | example | FHIR Device Types |
| Id | Path | Details | Requirements |
| dom-2 | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Procedure | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Procedure | 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-3 | Procedure | If 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() | |
| pro-1 | Procedure | Reason not done is only permitted if notDone indicator is true : notDoneReason.empty() or notDone = true | |
| ele-1 | Procedure.performer | All FHIR elements must have a @value or children : children().count() > id.count() | |
| ele-1 | Procedure.focalDevice | All FHIR elements must have a @value or children : children().count() > id.count() |
© HL7.org 2011+. FHIR STU3 Candidate (v3.0.1-11917) generated on
Fri, Feb 15, 2019 12:55-0500. QA Page
Links: Search 
| Version History | Table of Contents
| 
| Propose a change