Package google.fhir.stu3.proto

Index

• Account (message)
• Account.Coverage (message)
• Account.Guarantor (message)
• AccountStatusCode (message)
• AccountStatusCode.Value (enum)
• ActionCardinalityBehaviorCode (message)
• ActionCardinalityBehaviorCode.Value (enum)
• ActionConditionKindCode (message)
• ActionConditionKindCode.Value (enum)
• ActionGroupingBehaviorCode (message)
• ActionGroupingBehaviorCode.Value (enum)
• ActionListCode (message)
• ActionListCode.Value (enum)
• ActionParticipantTypeCode (message)
• ActionParticipantTypeCode.Value (enum)
• ActionPrecheckBehaviorCode (message)
• ActionPrecheckBehaviorCode.Value (enum)
• ActionRelationshipTypeCode (message)
• ActionRelationshipTypeCode.Value (enum)
• ActionRequiredBehaviorCode (message)
• ActionRequiredBehaviorCode.Value (enum)
• ActionSelectionBehaviorCode (message)
• ActionSelectionBehaviorCode.Value (enum)
• ActivityDefinition (message)
• ActivityDefinition.DynamicValue (message)
• ActivityDefinition.Participant (message)
• ActivityDefinition.Product (message)
• ActivityDefinition.TimingType (message)
• Address (message)
• AddressTypeCode (message)
• AddressTypeCode.Value (enum)
• AddressUseCode (message)
• AddressUseCode.Value (enum)
• AdministrativeGenderCode (message)
• AdministrativeGenderCode.Value (enum)
• AdverseEvent (message)
• AdverseEvent.SuspectEntity (message)
• AdverseEventCategoryCode (message)
• AdverseEventCategoryCode.Value (enum)
• AdverseEventCausalityCode (message)
• AdverseEventCausalityCode.Value (enum)
• Age (message)
• AggregationModeCode (message)
• AggregationModeCode.Value (enum)
• AllergyIntolerance (message)
• AllergyIntolerance.Onset (message)
• AllergyIntolerance.Reaction (message)
• AllergyIntoleranceCategoryCode (message)
• AllergyIntoleranceCategoryCode.Value (enum)
• AllergyIntoleranceClinicalStatusCode (message)
• AllergyIntoleranceClinicalStatusCode.Value (enum)
• AllergyIntoleranceCriticalityCode (message)
• AllergyIntoleranceCriticalityCode.Value (enum)
• AllergyIntoleranceSeverityCode (message)
• AllergyIntoleranceSeverityCode.Value (enum)
• AllergyIntoleranceTypeCode (message)
• AllergyIntoleranceTypeCode.Value (enum)
• AllergyIntoleranceVerificationStatusCode (message)
• AllergyIntoleranceVerificationStatusCode.Value (enum)
• Annotation (message)
• Annotation.Author (message)
• Appointment (message)
• Appointment.Participant (message)
• AppointmentResponse (message)
• AppointmentStatusCode (message)
• AppointmentStatusCode.Value (enum)
• AssertionDirectionTypeCode (message)
• AssertionDirectionTypeCode.Value (enum)
• AssertionOperatorTypeCode (message)
• AssertionOperatorTypeCode.Value (enum)
• AssertionResponseTypesCode (message)
• AssertionResponseTypesCode.Value (enum)
• Attachment (message)
• AuditEvent (message)
• AuditEvent.Agent (message)
• AuditEvent.Agent.Network (message)
• AuditEvent.Entity (message)
• AuditEvent.Entity.Detail (message)
• AuditEvent.Source (message)
• AuditEventActionCode (message)
• AuditEventActionCode.Value (enum)
• AuditEventAgentNetworkTypeCode (message)
• AuditEventAgentNetworkTypeCode.Value (enum)
• AuditEventOutcomeCode (message)
• AuditEventOutcomeCode.Value (enum)
• Base64Binary (message)
• Basic (message)
• Binary (message)
• BindingStrengthCode (message)
• BindingStrengthCode.Value (enum)
• BodySite (message)
• Boolean (message)
• Bundle (message)
• Bundle.Entry (message)
• Bundle.Entry.Request (message)
• Bundle.Entry.Response (message)
• Bundle.Entry.Search (message)
• Bundle.Link (message)
• BundleTypeCode (message)
• BundleTypeCode.Value (enum)
• CapabilityStatement (message)
• CapabilityStatement.Document (message)
• CapabilityStatement.Implementation (message)
• CapabilityStatement.Messaging (message)
• CapabilityStatement.Messaging.Endpoint (message)
• CapabilityStatement.Messaging.Event (message)
• CapabilityStatement.Messaging.SupportedMessage (message)
• CapabilityStatement.Rest (message)
• CapabilityStatement.Rest.Operation (message)
• CapabilityStatement.Rest.Resource (message)
• CapabilityStatement.Rest.Resource.ResourceInteraction (message)
• CapabilityStatement.Rest.Resource.SearchParam (message)
• CapabilityStatement.Rest.Security (message)
• CapabilityStatement.Rest.Security.Certificate (message)
• CapabilityStatement.Rest.SystemInteraction (message)
• CapabilityStatement.Software (message)
• CapabilityStatementKindCode (message)
• CapabilityStatementKindCode.Value (enum)
• CarePlan (message)
• CarePlan.Activity (message)
• CarePlan.Activity.Detail (message)
• CarePlan.Activity.Detail.Product (message)
• CarePlan.Activity.Detail.Scheduled (message)
• CarePlanActivityStatusCode (message)
• CarePlanActivityStatusCode.Value (enum)
• CarePlanIntentCode (message)
• CarePlanIntentCode.Value (enum)
• CarePlanStatusCode (message)
• CarePlanStatusCode.Value (enum)
• CareTeam (message)
• CareTeam.Participant (message)
• CareTeamStatusCode (message)
• CareTeamStatusCode.Value (enum)
• ChargeItem (message)
• ChargeItem.Occurrence (message)
• ChargeItem.Participant (message)
• ChargeItemStatusCode (message)
• ChargeItemStatusCode.Value (enum)
• Claim (message)
• Claim.Accident (message)
• Claim.Accident.Location (message)
• Claim.CareTeam (message)
• Claim.Diagnosis (message)
• Claim.Diagnosis.DiagnosisType (message)
• Claim.Insurance (message)
• Claim.Item (message)
• Claim.Item.Detail (message)
• Claim.Item.Detail.SubDetail (message)
• Claim.Item.Location (message)
• Claim.Item.Serviced (message)
• Claim.Payee (message)
• Claim.Procedure (message)
• Claim.Procedure.ProcedureType (message)
• Claim.RelatedClaim (message)
• Claim.SpecialCondition (message)
• Claim.SpecialCondition.TimingType (message)
• Claim.SpecialCondition.Value (message)
• ClaimResponse (message)
• ClaimResponse.AddedItem (message)
• ClaimResponse.AddedItem.AddedItemsDetail (message)
• ClaimResponse.Error (message)
• ClaimResponse.Insurance (message)
• ClaimResponse.Item (message)
• ClaimResponse.Item.Adjudication (message)
• ClaimResponse.Item.ItemDetail (message)
• ClaimResponse.Item.ItemDetail.SubDetail (message)
• ClaimResponse.Note (message)
• ClaimResponse.Payment (message)
• ClinicalImpression (message)
• ClinicalImpression.Effective (message)
• ClinicalImpression.Finding (message)
• ClinicalImpression.Finding.Item (message)
• ClinicalImpression.Investigation (message)
• ClinicalImpressionStatusCode (message)
• ClinicalImpressionStatusCode.Value (enum)
• Code (message)
• CodeSystem (message)
• CodeSystem.ConceptDefinition (message)
• CodeSystem.ConceptDefinition.ConceptProperty (message)
• CodeSystem.ConceptDefinition.ConceptProperty.Value (message)
• CodeSystem.ConceptDefinition.Designation (message)
• CodeSystem.Filter (message)
• CodeSystem.Property (message)
• CodeSystemContentModeCode (message)
• CodeSystemContentModeCode.Value (enum)
• CodeSystemHierarchyMeaningCode (message)
• CodeSystemHierarchyMeaningCode.Value (enum)
• CodeableConcept (message)
• Coding (message)
• Communication (message)
• Communication.Payload (message)
• Communication.Payload.Content (message)
• CommunicationRequest (message)
• CommunicationRequest.Occurrence (message)
• CommunicationRequest.Payload (message)
• CommunicationRequest.Payload.Content (message)
• CommunicationRequest.Requester (message)
• CompartmentDefinition (message)
• CompartmentDefinition.Resource (message)
• CompartmentTypeCode (message)
• CompartmentTypeCode.Value (enum)
• Composition (message)
• Composition.Attester (message)
• Composition.Event (message)
• Composition.RelatesTo (message)
• Composition.RelatesTo.Target (message)
• Composition.Section (message)
• CompositionAttestationModeCode (message)
• CompositionAttestationModeCode.Value (enum)
• CompositionStatusCode (message)
• CompositionStatusCode.Value (enum)
• ConceptMap (message)
• ConceptMap.Group (message)
• ConceptMap.Group.SourceElement (message)
• ConceptMap.Group.SourceElement.TargetElement (message)
• ConceptMap.Group.SourceElement.TargetElement.OtherElement (message)
• ConceptMap.Group.Unmapped (message)
• ConceptMap.Source (message)
• ConceptMap.Target (message)
• ConceptMapEquivalenceCode (message)
• ConceptMapEquivalenceCode.Value (enum)
• ConceptMapGroupUnmappedModeCode (message)
• ConceptMapGroupUnmappedModeCode.Value (enum)
• Condition (message)
• Condition.Abatement (message)
• Condition.Evidence (message)
• Condition.Onset (message)
• Condition.Stage (message)
• ConditionClinicalStatusCodesCode (message)
• ConditionClinicalStatusCodesCode.Value (enum)
• ConditionVerificationStatusCode (message)
• ConditionVerificationStatusCode.Value (enum)
• ConditionalDeleteStatusCode (message)
• ConditionalDeleteStatusCode.Value (enum)
• ConditionalReadStatusCode (message)
• ConditionalReadStatusCode.Value (enum)
• ConfidentialityClassificationCode (message)
• ConfidentialityClassificationCode.Value (enum)
• Consent (message)
• Consent.Actor (message)
• Consent.Data (message)
• Consent.Except (message)
• Consent.Except.ExceptActor (message)
• Consent.Except.ExceptData (message)
• Consent.Policy (message)
• Consent.Source (message)
• ConsentDataMeaningCode (message)
• ConsentDataMeaningCode.Value (enum)
• ConsentExceptTypeCode (message)
• ConsentExceptTypeCode.Value (enum)
• ConsentStateCode (message)
• ConsentStateCode.Value (enum)
• ConstraintSeverityCode (message)
• ConstraintSeverityCode.Value (enum)
• ContactDetail (message)
• ContactPoint (message)
• ContactPointSystemCode (message)
• ContactPointSystemCode.Value (enum)
• ContactPointUseCode (message)
• ContactPointUseCode.Value (enum)
• ContainedResource (message)
• ContentTypeCode (message)
• ContentTypeCode.Value (enum)
• Contract (message)
• Contract.Agent (message)
• Contract.Binding (message)
• Contract.ComputableLanguage (message)
• Contract.ComputableLanguage.Content (message)
• Contract.FriendlyLanguage (message)
• Contract.FriendlyLanguage.Content (message)
• Contract.LegalLanguage (message)
• Contract.LegalLanguage.Content (message)
• Contract.Signatory (message)
• Contract.Term (message)
• Contract.Term.TermAgent (message)
• Contract.Term.TermValuedItem (message)
• Contract.Term.TermValuedItem.Entity (message)
• Contract.ValuedItem (message)
• Contract.ValuedItem.Entity (message)
• ContractResourceStatusCode (message)
• ContractResourceStatusCode.Value (enum)
• Contributor (message)
• ContributorTypeCode (message)
• ContributorTypeCode.Value (enum)
• Count (message)
• Coverage (message)
• Coverage.Group (message)
• DataElement (message)
• DataElement.Mapping (message)
• DataElementStringencyCode (message)
• DataElementStringencyCode.Value (enum)
• DataRequirement (message)
• DataRequirement.CodeFilter (message)
• DataRequirement.CodeFilter.ValueSet (message)
• DataRequirement.DateFilter (message)
• DataRequirement.DateFilter.Value (message)
• Date (message)
• Date.Precision (enum)
• DateTime (message)
• DateTime.Precision (enum)
• DaysOfWeekCode (message)
• DaysOfWeekCode.Value (enum)
• Decimal (message)
• DetectedIssue (message)
• DetectedIssue.Mitigation (message)
• DetectedIssueSeverityCode (message)
• DetectedIssueSeverityCode.Value (enum)
• Device (message)
• Device.Udi (message)
• DeviceComponent (message)
• DeviceComponent.ProductionSpecification (message)
• DeviceMetric (message)
• DeviceMetric.Calibration (message)
• DeviceMetricCalibrationStateCode (message)
• DeviceMetricCalibrationStateCode.Value (enum)
• DeviceMetricCalibrationTypeCode (message)
• DeviceMetricCalibrationTypeCode.Value (enum)
• DeviceMetricCategoryCode (message)
• DeviceMetricCategoryCode.Value (enum)
• DeviceMetricColorCode (message)
• DeviceMetricColorCode.Value (enum)
• DeviceMetricOperationalStatusCode (message)
• DeviceMetricOperationalStatusCode.Value (enum)
• DeviceRequest (message)
• DeviceRequest.Code (message)
• DeviceRequest.Occurrence (message)
• DeviceRequest.Requester (message)
• DeviceUseStatement (message)
• DeviceUseStatement.TimingType (message)
• DeviceUseStatementStatusCode (message)
• DeviceUseStatementStatusCode.Value (enum)
• DiagnosticReport (message)
• DiagnosticReport.Effective (message)
• DiagnosticReport.Image (message)
• DiagnosticReport.Performer (message)
• DiagnosticReportStatusCode (message)
• DiagnosticReportStatusCode.Value (enum)
• DigitalMediaTypeCode (message)
• DigitalMediaTypeCode.Value (enum)
• DiscriminatorTypeCode (message)
• DiscriminatorTypeCode.Value (enum)
• Distance (message)
• DocumentManifest (message)
• DocumentManifest.Content (message)
• DocumentManifest.Content.P (message)
• DocumentManifest.Related (message)
• DocumentModeCode (message)
• DocumentModeCode.Value (enum)
• DocumentReference (message)
• DocumentReference.Content (message)
• DocumentReference.Context (message)
• DocumentReference.Context.Related (message)
• DocumentReference.RelatesTo (message)
• DocumentReferenceStatusCode (message)
• DocumentReferenceStatusCode.Value (enum)
• DocumentRelationshipTypeCode (message)
• DocumentRelationshipTypeCode.Value (enum)
• Dosage (message)
• Dosage.AsNeeded (message)
• Dosage.Dose (message)
• Dosage.Rate (message)
• Duration (message)
• ElementDefinition (message)
• ElementDefinition.Base (message)
• ElementDefinition.Constraint (message)
• ElementDefinition.DefaultValue (message)
• ElementDefinition.ElementDefinitionBinding (message)
• ElementDefinition.ElementDefinitionBinding.ValueSet (message)
• ElementDefinition.Example (message)
• ElementDefinition.Example.Value (message)
• ElementDefinition.Fixed (message)
• ElementDefinition.Mapping (message)
• ElementDefinition.MaxValue (message)
• ElementDefinition.MinValue (message)
• ElementDefinition.Pattern (message)
• ElementDefinition.Slicing (message)
• ElementDefinition.Slicing.Discriminator (message)
• ElementDefinition.TypeRef (message)
• EligibilityRequest (message)
• EligibilityRequest.Serviced (message)
• EligibilityResponse (message)
• EligibilityResponse.Errors (message)
• EligibilityResponse.Insurance (message)
• EligibilityResponse.Insurance.Benefits (message)
• EligibilityResponse.Insurance.Benefits.Benefit (message)
• EligibilityResponse.Insurance.Benefits.Benefit.Allowed (message)
• EligibilityResponse.Insurance.Benefits.Benefit.Used (message)
• Encounter (message)
• Encounter.ClassHistory (message)
• Encounter.Diagnosis (message)
• Encounter.Hospitalization (message)
• Encounter.Location (message)
• Encounter.Participant (message)
• Encounter.StatusHistory (message)
• EncounterLocationStatusCode (message)
• EncounterLocationStatusCode.Value (enum)
• EncounterStatusCode (message)
• EncounterStatusCode.Value (enum)
• Endpoint (message)
• EndpointStatusCode (message)
• EndpointStatusCode.Value (enum)
• EnrollmentRequest (message)
• EnrollmentResponse (message)
• EpisodeOfCare (message)
• EpisodeOfCare.Diagnosis (message)
• EpisodeOfCare.StatusHistory (message)
• EpisodeOfCareStatusCode (message)
• EpisodeOfCareStatusCode.Value (enum)
• EventCapabilityModeCode (message)
• EventCapabilityModeCode.Value (enum)
• EventStatusCode (message)
• EventStatusCode.Value (enum)
• EventTimingCode (message)
• EventTimingCode.Value (enum)
• ExpansionProfile (message)
• ExpansionProfile.Designation (message)
• ExpansionProfile.Designation.DesignationExclude (message)
• ExpansionProfile.Designation.DesignationExclude.DesignationExcludeDesignation (message)
• ExpansionProfile.Designation.DesignationInclude (message)
• ExpansionProfile.Designation.DesignationInclude.DesignationIncludeDesignation (message)
• ExpansionProfile.ExcludedSystem (message)
• ExpansionProfile.FixedVersion (message)
• ExplanationOfBenefit (message)
• ExplanationOfBenefit.Accident (message)
• ExplanationOfBenefit.Accident.Location (message)
• ExplanationOfBenefit.AddedItem (message)
• ExplanationOfBenefit.AddedItem.AddedItemsDetail (message)
• ExplanationOfBenefit.BenefitBalance (message)
• ExplanationOfBenefit.BenefitBalance.Benefit (message)
• ExplanationOfBenefit.BenefitBalance.Benefit.Allowed (message)
• ExplanationOfBenefit.BenefitBalance.Benefit.Used (message)
• ExplanationOfBenefit.CareTeam (message)
• ExplanationOfBenefit.Diagnosis (message)
• ExplanationOfBenefit.Diagnosis.DiagnosisType (message)
• ExplanationOfBenefit.Insurance (message)
• ExplanationOfBenefit.Item (message)
• ExplanationOfBenefit.Item.Adjudication (message)
• ExplanationOfBenefit.Item.Detail (message)
• ExplanationOfBenefit.Item.Detail.SubDetail (message)
• ExplanationOfBenefit.Item.Location (message)
• ExplanationOfBenefit.Item.Serviced (message)
• ExplanationOfBenefit.Note (message)
• ExplanationOfBenefit.Payee (message)
• ExplanationOfBenefit.Payment (message)
• ExplanationOfBenefit.Procedure (message)
• ExplanationOfBenefit.Procedure.ProcedureType (message)
• ExplanationOfBenefit.RelatedClaim (message)
• ExplanationOfBenefit.SupportingInformation (message)
• ExplanationOfBenefit.SupportingInformation.TimingType (message)
• ExplanationOfBenefit.SupportingInformation.Value (message)
• ExplanationOfBenefitStatusCode (message)
• ExplanationOfBenefitStatusCode.Value (enum)
• Extension (message)
• Extension.ValueX (message)
• ExtensionContextCode (message)
• ExtensionContextCode.Value (enum)
• FHIRAllTypesCode (message)
• FHIRAllTypesCode.Value (enum)
• FHIRDefinedTypeCode (message)
• FHIRDefinedTypeCode.Value (enum)
• FHIRDefinedTypeExtCode (message)
• FHIRDeviceStatusCode (message)
• FHIRDeviceStatusCode.Value (enum)
• FHIRSubstanceStatusCode (message)
• FHIRSubstanceStatusCode.Value (enum)
• FamilyHistoryStatusCode (message)
• FamilyHistoryStatusCode.Value (enum)
• FamilyMemberHistory (message)
• FamilyMemberHistory.AgeType (message)
• FamilyMemberHistory.Born (message)
• FamilyMemberHistory.Condition (message)
• FamilyMemberHistory.Condition.Onset (message)
• FamilyMemberHistory.Deceased (message)
• FilterOperatorCode (message)
• FilterOperatorCode.Value (enum)
• FinancialResourceStatusCode (message)
• FinancialResourceStatusCode.Value (enum)
• Flag (message)
• FlagStatusCode (message)
• FlagStatusCode.Value (enum)
• Goal (message)
• Goal.Start (message)
• Goal.Target (message)
• Goal.Target.Detail (message)
• Goal.Target.Due (message)
• GoalStatusCode (message)
• GoalStatusCode.Value (enum)
• GraphCompartmentRuleCode (message)
• GraphCompartmentRuleCode.Value (enum)
• GraphDefinition (message)
• GraphDefinition.Link (message)
• GraphDefinition.Link.Target (message)
• GraphDefinition.Link.Target.Compartment (message)
• Group (message)
• Group.Characteristic (message)
• Group.Characteristic.Value (message)
• Group.Member (message)
• GroupTypeCode (message)
• GroupTypeCode.Value (enum)
• GuidanceResponse (message)
• GuidanceResponse.Reason (message)
• GuidanceResponseStatusCode (message)
• GuidanceResponseStatusCode.Value (enum)
• GuideDependencyTypeCode (message)
• GuideDependencyTypeCode.Value (enum)
• GuidePageKindCode (message)
• GuidePageKindCode.Value (enum)
• HTTPVerbCode (message)
• HTTPVerbCode.Value (enum)
• HealthcareService (message)
• HealthcareService.AvailableTime (message)
• HealthcareService.NotAvailable (message)
• HumanName (message)
• Id (message)
• Identifier (message)
• IdentifierUseCode (message)
• IdentifierUseCode.Value (enum)
• IdentityAssuranceLevelCode (message)
• IdentityAssuranceLevelCode.Value (enum)
• ImagingManifest (message)
• ImagingManifest.Study (message)
• ImagingManifest.Study.Series (message)
• ImagingManifest.Study.Series.Instance (message)
• ImagingStudy (message)
• ImagingStudy.Series (message)
• ImagingStudy.Series.Instance (message)
• Immunization (message)
• Immunization.Explanation (message)
• Immunization.Practitioner (message)
• Immunization.Reaction (message)
• Immunization.VaccinationProtocol (message)
• ImmunizationRecommendation (message)
• ImmunizationRecommendation.Recommendation (message)
• ImmunizationRecommendation.Recommendation.DateCriterion (message)
• ImmunizationRecommendation.Recommendation.Protocol (message)
• ImmunizationStatusCodesCode (message)
• ImmunizationStatusCodesCode.Value (enum)
• ImplementationGuide (message)
• ImplementationGuide.Dependency (message)
• ImplementationGuide.Global (message)
• ImplementationGuide.Package (message)
• ImplementationGuide.Package.Resource (message)
• ImplementationGuide.Package.Resource.Source (message)
• ImplementationGuide.Page (message)
• InstanceAvailabilityCode (message)
• InstanceAvailabilityCode.Value (enum)
• Instant (message)
• Instant.Precision (enum)
• Integer (message)
• IssueSeverityCode (message)
• IssueSeverityCode.Value (enum)
• IssueTypeCode (message)
• IssueTypeCode.Value (enum)
• LanguageCode (message)
• Library (message)
• LinkTypeCode (message)
• LinkTypeCode.Value (enum)
• Linkage (message)
• Linkage.Item (message)
• LinkageTypeCode (message)
• LinkageTypeCode.Value (enum)
• List (message)
• List.Entry (message)
• ListModeCode (message)
• ListModeCode.Value (enum)
• ListStatusCode (message)
• ListStatusCode.Value (enum)
• Location (message)
• Location.Position (message)
• LocationModeCode (message)
• LocationModeCode.Value (enum)
• LocationStatusCode (message)
• LocationStatusCode.Value (enum)
• Markdown (message)
• MeasmntPrincipleCode (message)
• MeasmntPrincipleCode.Value (enum)
• Measure (message)
• Measure.Group (message)
• Measure.Group.Population (message)
• Measure.Group.Stratifier (message)
• Measure.SupplementalData (message)
• MeasureReport (message)
• MeasureReport.Group (message)
• MeasureReport.Group.Population (message)
• MeasureReport.Group.Stratifier (message)
• MeasureReport.Group.Stratifier.StratifierGroup (message)
• MeasureReport.Group.Stratifier.StratifierGroup.StratifierGroupPopulation (message)
• MeasureReportStatusCode (message)
• MeasureReportStatusCode.Value (enum)
• MeasureReportTypeCode (message)
• MeasureReportTypeCode.Value (enum)
• Media (message)
• Media.Occurrence (message)
• Medication (message)
• Medication.Ingredient (message)
• Medication.Ingredient.Item (message)
• Medication.Package (message)
• Medication.Package.Batch (message)
• Medication.Package.Content (message)
• Medication.Package.Content.Item (message)
• MedicationAdministration (message)
• MedicationAdministration.Dosage (message)
• MedicationAdministration.Dosage.Rate (message)
• MedicationAdministration.Effective (message)
• MedicationAdministration.Medication (message)
• MedicationAdministration.Performer (message)
• MedicationAdministrationStatusCode (message)
• MedicationAdministrationStatusCode.Value (enum)
• MedicationDispense (message)
• MedicationDispense.Medication (message)
• MedicationDispense.NotDoneReason (message)
• MedicationDispense.Performer (message)
• MedicationDispense.Substitution (message)
• MedicationDispenseStatusCode (message)
• MedicationDispenseStatusCode.Value (enum)
• MedicationRequest (message)
• MedicationRequest.DispenseRequest (message)
• MedicationRequest.Medication (message)
• MedicationRequest.Requester (message)
• MedicationRequest.Substitution (message)
• MedicationRequestIntentCode (message)
• MedicationRequestIntentCode.Value (enum)
• MedicationRequestPriorityCode (message)
• MedicationRequestPriorityCode.Value (enum)
• MedicationRequestStatusCode (message)
• MedicationRequestStatusCode.Value (enum)
• MedicationStatement (message)
• MedicationStatement.Effective (message)
• MedicationStatement.Medication (message)
• MedicationStatementStatusCode (message)
• MedicationStatementStatusCode.Value (enum)
• MedicationStatementTakenCode (message)
• MedicationStatementTakenCode.Value (enum)
• MedicationStatusCode (message)
• MedicationStatusCode.Value (enum)
• MessageDefinition (message)
• MessageDefinition.AllowedResponse (message)
• MessageDefinition.Focus (message)
• MessageHeader (message)
• MessageHeader.MessageDestination (message)
• MessageHeader.MessageSource (message)
• MessageHeader.Response (message)
• MessageSignificanceCategoryCode (message)
• MessageSignificanceCategoryCode.Value (enum)
• Meta (message)
• MimeTypeCode (message)
• Money (message)
• NameUseCode (message)
• NameUseCode.Value (enum)
• NamingSystem (message)
• NamingSystem.UniqueId (message)
• NamingSystemIdentifierTypeCode (message)
• NamingSystemIdentifierTypeCode.Value (enum)
• NamingSystemTypeCode (message)
• NamingSystemTypeCode.Value (enum)
• Narrative (message)
• NarrativeStatusCode (message)
• NarrativeStatusCode.Value (enum)
• NutritionOrder (message)
• NutritionOrder.EnteralFormula (message)
• NutritionOrder.EnteralFormula.Administration (message)
• NutritionOrder.EnteralFormula.Administration.Rate (message)
• NutritionOrder.OralDiet (message)
• NutritionOrder.OralDiet.Nutrient (message)
• NutritionOrder.OralDiet.Texture (message)
• NutritionOrder.Supplement (message)
• NutritionOrderStatusCode (message)
• NutritionOrderStatusCode.Value (enum)
• Observation (message)
• Observation.Component (message)
• Observation.Component.Value (message)
• Observation.Effective (message)
• Observation.ReferenceRange (message)
• Observation.Related (message)
• Observation.Value (message)
• ObservationRelationshipTypeCode (message)
• ObservationRelationshipTypeCode.Value (enum)
• ObservationStatusCode (message)
• ObservationStatusCode.Value (enum)
• Oid (message)
• OperationDefinition (message)
• OperationDefinition.Overload (message)
• OperationDefinition.Parameter (message)
• OperationDefinition.Parameter.Binding (message)
• OperationDefinition.Parameter.Binding.ValueSet (message)
• OperationKindCode (message)
• OperationKindCode.Value (enum)
• OperationOutcome (message)
• OperationOutcome.Issue (message)
• OperationParameterUseCode (message)
• OperationParameterUseCode.Value (enum)
• Organization (message)
• Organization.Contact (message)
• ParameterDefinition (message)
• Parameters (message)
• Parameters.Parameter (message)
• Parameters.Parameter.Value (message)
• ParticipantRequiredCode (message)
• ParticipantRequiredCode.Value (enum)
• ParticipationStatusCode (message)
• ParticipationStatusCode.Value (enum)
• Patient (message)
• Patient.Animal (message)
• Patient.Communication (message)
• Patient.Contact (message)
• Patient.Deceased (message)
• Patient.Link (message)
• Patient.MultipleBirth (message)
• PaymentNotice (message)
• PaymentReconciliation (message)
• PaymentReconciliation.Details (message)
• PaymentReconciliation.Notes (message)
• Period (message)
• Person (message)
• Person.Link (message)
• PlanDefinition (message)
• PlanDefinition.Action (message)
• PlanDefinition.Action.Condition (message)
• PlanDefinition.Action.DynamicValue (message)
• PlanDefinition.Action.Participant (message)
• PlanDefinition.Action.RelatedAction (message)
• PlanDefinition.Action.RelatedAction.Offset (message)
• PlanDefinition.Action.TimingType (message)
• PlanDefinition.Goal (message)
• PlanDefinition.Goal.Target (message)
• PlanDefinition.Goal.Target.Detail (message)
• PositiveInt (message)
• Practitioner (message)
• Practitioner.Qualification (message)
• PractitionerRole (message)
• PractitionerRole.AvailableTime (message)
• PractitionerRole.NotAvailable (message)
• Procedure (message)
• Procedure.FocalDevice (message)
• Procedure.Performed (message)
• Procedure.Performer (message)
• ProcedureRequest (message)
• ProcedureRequest.AsNeeded (message)
• ProcedureRequest.Occurrence (message)
• ProcedureRequest.Requester (message)
• ProcessRequest (message)
• ProcessRequest.Items (message)
• ProcessResponse (message)
• ProcessResponse.ProcessNote (message)
• PropertyRepresentationCode (message)
• PropertyRepresentationCode.Value (enum)
• PropertyTypeCode (message)
• PropertyTypeCode.Value (enum)
• Provenance (message)
• Provenance.Agent (message)
• Provenance.Agent.OnBehalfOf (message)
• Provenance.Agent.Who (message)
• Provenance.Entity (message)
• Provenance.Entity.What (message)
• ProvenanceEntityRoleCode (message)
• ProvenanceEntityRoleCode.Value (enum)
• PublicationStatusCode (message)
• PublicationStatusCode.Value (enum)
• QualityTypeCode (message)
• QualityTypeCode.Value (enum)
• Quantity (message)
• QuantityComparatorCode (message)
• QuantityComparatorCode.Value (enum)
• Questionnaire (message)
• Questionnaire.Item (message)
• Questionnaire.Item.EnableWhen (message)
• Questionnaire.Item.EnableWhen.Answer (message)
• Questionnaire.Item.Initial (message)
• Questionnaire.Item.Option (message)
• Questionnaire.Item.Option.Value (message)
• QuestionnaireItemTypeCode (message)
• QuestionnaireItemTypeCode.Value (enum)
• QuestionnaireResponse (message)
• QuestionnaireResponse.Item (message)
• QuestionnaireResponse.Item.Answer (message)
• QuestionnaireResponse.Item.Answer.Value (message)
• QuestionnaireResponseStatusCode (message)
• QuestionnaireResponseStatusCode.Value (enum)
• Range (message)
• Ratio (message)
• Reference (message)
• ReferenceHandlingPolicyCode (message)
• ReferenceHandlingPolicyCode.Value (enum)
• ReferenceId (message)
• ReferenceVersionRulesCode (message)
• ReferenceVersionRulesCode.Value (enum)
• ReferralRequest (message)
• ReferralRequest.Occurrence (message)
• ReferralRequest.Requester (message)
• RelatedArtifact (message)
• RelatedArtifactTypeCode (message)
• RelatedArtifactTypeCode.Value (enum)
• RelatedPerson (message)
• RepositoryTypeCode (message)
• RepositoryTypeCode.Value (enum)
• RequestGroup (message)
• RequestGroup.Action (message)
• RequestGroup.Action.Condition (message)
• RequestGroup.Action.RelatedAction (message)
• RequestGroup.Action.RelatedAction.Offset (message)
• RequestGroup.Action.TimingType (message)
• RequestGroup.Reason (message)
• RequestIntentCode (message)
• RequestIntentCode.Value (enum)
• RequestPriorityCode (message)
• RequestPriorityCode.Value (enum)
• RequestStatusCode (message)
• RequestStatusCode.Value (enum)
• ResearchStudy (message)
• ResearchStudy.Arm (message)
• ResearchStudyStatusCode (message)
• ResearchStudyStatusCode.Value (enum)
• ResearchSubject (message)
• ResearchSubjectStatusCode (message)
• ResearchSubjectStatusCode.Value (enum)
• ResourceTypeCode (message)
• ResourceTypeCode.Value (enum)
• ResourceVersionPolicyCode (message)
• ResourceVersionPolicyCode.Value (enum)
• ResponseTypeCode (message)
• ResponseTypeCode.Value (enum)
• RestfulCapabilityModeCode (message)
• RestfulCapabilityModeCode.Value (enum)
• RiskAssessment (message)
• RiskAssessment.Occurrence (message)
• RiskAssessment.Prediction (message)
• RiskAssessment.Prediction.Probability (message)
• RiskAssessment.Prediction.When (message)
• RiskAssessment.Reason (message)
• SampledData (message)
• Schedule (message)
• SearchComparatorCode (message)
• SearchComparatorCode.Value (enum)
• SearchEntryModeCode (message)
• SearchEntryModeCode.Value (enum)
• SearchModifierCodeCode (message)
• SearchModifierCodeCode.Value (enum)
• SearchParamTypeCode (message)
• SearchParamTypeCode.Value (enum)
• SearchParameter (message)
• SearchParameter.Component (message)
• Sequence (message)
• Sequence.Quality (message)
• Sequence.ReferenceSeq (message)
• Sequence.Repository (message)
• Sequence.Variant (message)
• SequenceTypeCode (message)
• SequenceTypeCode.Value (enum)
• ServiceDefinition (message)
• Signature (message)
• Signature.OnBehalfOf (message)
• Signature.Who (message)
• SimpleQuantity (message)
• SlicingRulesCode (message)
• SlicingRulesCode.Value (enum)
• Slot (message)
• SlotStatusCode (message)
• SlotStatusCode.Value (enum)
• Specimen (message)
• Specimen.Collection (message)
• Specimen.Collection.Collected (message)
• Specimen.Container (message)
• Specimen.Container.Additive (message)
• Specimen.Processing (message)
• Specimen.Processing.Time (message)
• SpecimenStatusCode (message)
• SpecimenStatusCode.Value (enum)
• String (message)
• StructureDefinition (message)
• StructureDefinition.Differential (message)
• StructureDefinition.Mapping (message)
• StructureDefinition.Snapshot (message)
• StructureDefinitionKindCode (message)
• StructureDefinitionKindCode.Value (enum)
• StructureMap (message)
• StructureMap.Group (message)
• StructureMap.Group.Input (message)
• StructureMap.Group.Rule (message)
• StructureMap.Group.Rule.Dependent (message)
• StructureMap.Group.Rule.Source (message)
• StructureMap.Group.Rule.Source.DefaultValue (message)
• StructureMap.Group.Rule.Target (message)
• StructureMap.Group.Rule.Target.Parameter (message)
• StructureMap.Group.Rule.Target.Parameter.Value (message)
• StructureMap.Structure (message)
• StructureMapContextTypeCode (message)
• StructureMapContextTypeCode.Value (enum)
• StructureMapGroupTypeModeCode (message)
• StructureMapGroupTypeModeCode.Value (enum)
• StructureMapInputModeCode (message)
• StructureMapInputModeCode.Value (enum)
• StructureMapModelModeCode (message)
• StructureMapModelModeCode.Value (enum)
• StructureMapSourceListModeCode (message)
• StructureMapSourceListModeCode.Value (enum)
• StructureMapTargetListModeCode (message)
• StructureMapTargetListModeCode.Value (enum)
• StructureMapTransformCode (message)
• StructureMapTransformCode.Value (enum)
• Subscription (message)
• Subscription.Channel (message)
• SubscriptionChannelTypeCode (message)
• SubscriptionChannelTypeCode.Value (enum)
• SubscriptionStatusCode (message)
• SubscriptionStatusCode.Value (enum)
• Substance (message)
• Substance.Ingredient (message)
• Substance.Ingredient.SubstanceType (message)
• Substance.Instance (message)
• SupplyDelivery (message)
• SupplyDelivery.Occurrence (message)
• SupplyDelivery.SuppliedItem (message)
• SupplyDelivery.SuppliedItem.Item (message)
• SupplyDeliveryStatusCode (message)
• SupplyDeliveryStatusCode.Value (enum)
• SupplyRequest (message)
• SupplyRequest.Occurrence (message)
• SupplyRequest.OrderedItem (message)
• SupplyRequest.OrderedItem.Item (message)
• SupplyRequest.Reason (message)
• SupplyRequest.Requester (message)
• SupplyRequestStatusCode (message)
• SupplyRequestStatusCode.Value (enum)
• SystemRestfulInteractionCode (message)
• SystemRestfulInteractionCode.Value (enum)
• SystemVersionProcessingModeCode (message)
• SystemVersionProcessingModeCode.Value (enum)
• Task (message)
• Task.Definition (message)
• Task.Output (message)
• Task.Output.Value (message)
• Task.Parameter (message)
• Task.Parameter.Value (message)
• Task.Requester (message)
• Task.Restriction (message)
• TaskStatusCode (message)
• TaskStatusCode.Value (enum)
• TestReport (message)
• TestReport.Participant (message)
• TestReport.Setup (message)
• TestReport.Setup.SetupAction (message)
• TestReport.Setup.SetupAction.Assert (message)
• TestReport.Setup.SetupAction.Operation (message)
• TestReport.Teardown (message)
• TestReport.Teardown.TeardownAction (message)
• TestReport.Test (message)
• TestReport.Test.TestAction (message)
• TestReportActionResultCode (message)
• TestReportActionResultCode.Value (enum)
• TestReportParticipantTypeCode (message)
• TestReportParticipantTypeCode.Value (enum)
• TestReportResultCode (message)
• TestReportResultCode.Value (enum)
• TestReportStatusCode (message)
• TestReportStatusCode.Value (enum)
• TestScript (message)
• TestScript.Destination (message)
• TestScript.Fixture (message)
• TestScript.Metadata (message)
• TestScript.Metadata.Capability (message)
• TestScript.Metadata.Link (message)
• TestScript.Origin (message)
• TestScript.Rule (message)
• TestScript.Rule.RuleParam (message)
• TestScript.Ruleset (message)
• TestScript.Ruleset.RulesetRule (message)
• TestScript.Ruleset.RulesetRule.RulesetRuleParam (message)
• TestScript.Setup (message)
• TestScript.Setup.SetupAction (message)
• TestScript.Setup.SetupAction.Assert (message)
• TestScript.Setup.SetupAction.Assert.ActionAssertRule (message)
• TestScript.Setup.SetupAction.Assert.ActionAssertRule.ActionAssertRuleParam (message)
• TestScript.Setup.SetupAction.Assert.ActionAssertRuleset (message)
• TestScript.Setup.SetupAction.Assert.ActionAssertRuleset.ActionAssertRulesetRule (message)
• TestScript.Setup.SetupAction.Assert.ActionAssertRuleset.ActionAssertRulesetRule.Param (message)
• TestScript.Setup.SetupAction.Operation (message)
• TestScript.Setup.SetupAction.Operation.RequestHeader (message)
• TestScript.Teardown (message)
• TestScript.Teardown.TeardownAction (message)
• TestScript.Test (message)
• TestScript.Test.TestAction (message)
• TestScript.Variable (message)
• TestScriptRequestMethodCodeCode (message)
• TestScriptRequestMethodCodeCode.Value (enum)
• Time (message)
• Time.Precision (enum)
• Timing (message)
• Timing.Repeat (message)
• Timing.Repeat.Bounds (message)
• TriggerDefinition (message)
• TriggerDefinition.EventTiming (message)
• TriggerTypeCode (message)
• TriggerTypeCode.Value (enum)
• TypeDerivationRuleCode (message)
• TypeDerivationRuleCode.Value (enum)
• TypeRestfulInteractionCode (message)
• TypeRestfulInteractionCode.Value (enum)
• UDIEntryTypeCode (message)
• UDIEntryTypeCode.Value (enum)
• UnitsOfTimeCode (message)
• UnitsOfTimeCode.Value (enum)
• UnknownContentCodeCode (message)
• UnknownContentCodeCode.Value (enum)
• UnsignedInt (message)
• Uri (message)
• UsageContext (message)
• UsageContext.Value (message)
• UseCode (message)
• UseCode.Value (enum)
• ValueSet (message)
• ValueSet.Compose (message)
• ValueSet.Compose.ConceptSet (message)
• ValueSet.Compose.ConceptSet.ConceptReference (message)
• ValueSet.Compose.ConceptSet.ConceptReference.Designation (message)
• ValueSet.Compose.ConceptSet.Filter (message)
• ValueSet.Expansion (message)
• ValueSet.Expansion.Contains (message)
• ValueSet.Expansion.Parameter (message)
• ValueSet.Expansion.Parameter.Value (message)
• VisionBaseCode (message)
• VisionBaseCode.Value (enum)
• VisionEyesCode (message)
• VisionEyesCode.Value (enum)
• VisionPrescription (message)
• VisionPrescription.Dispense (message)
• VisionPrescription.Reason (message)
• XPathUsageTypeCode (message)
• XPathUsageTypeCode.Value (enum)
• Xhtml (message)

Account

Auto-generated from StructureDefinition for Account, last updated 2017-04-19T07:44:43.294+10:00. Tracks balance, charges, for patient or cost center. See http://hl7.org/fhir/StructureDefinition/Account

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Account number
status	AccountStatusCode active | inactive | entered-in-error
type	CodeableConcept E.g. patient, expense, depreciation
name	String Human-readable label
subject	Reference What is account tied to?
period	Period Transaction window
active	Period Time window that transactions may be posted to this account
balance	Money How much is in account?
coverage[]	Coverage
owner	Reference Who is responsible?
description	String Explanation of purpose/use
guarantor[]	Guarantor

Coverage

The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
coverage	Reference The party(s) that are responsible for covering the payment of this account
priority	PositiveInt The priority of the coverage in the context of this account

Guarantor

Responsible for the account

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
party	Reference Responsible entity
on_hold	Boolean Credit or other hold applied
period	Period Guarrantee account during

AccountStatusCode

Indicates whether the account is available to be used. See http://hl7.org/fhir/ValueSet/account-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
INACTIVE
ENTERED_IN_ERROR

ActionCardinalityBehaviorCode

Defines behavior for an action or a group for how many times that item may be repeated See http://hl7.org/fhir/ValueSet/action-cardinality-behavior

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
SINGLE
MULTIPLE

ActionConditionKindCode

Defines the kinds of conditions that can appear on actions See http://hl7.org/fhir/ValueSet/action-condition-kind

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
APPLICABILITY
START
STOP

ActionGroupingBehaviorCode

Defines organization behavior of a group See http://hl7.org/fhir/ValueSet/action-grouping-behavior

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
VISUAL_GROUP
LOGICAL_GROUP
SENTENCE_GROUP

ActionListCode

List of allowable action which this resource can request. See http://hl7.org/fhir/ValueSet/actionlist

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CANCEL
POLL
REPROCESS
STATUS

ActionParticipantTypeCode

The type of participant for the action See http://hl7.org/fhir/ValueSet/action-participant-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PATIENT
PRACTITIONER
RELATED_PERSON

ActionPrecheckBehaviorCode

Defines selection frequency behavior for an action or group See http://hl7.org/fhir/ValueSet/action-precheck-behavior

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
YES
NO

ActionRelationshipTypeCode

Defines the types of relationships between actions See http://hl7.org/fhir/ValueSet/action-relationship-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
BEFORE_START
BEFORE
BEFORE_END
CONCURRENT_WITH_START
CONCURRENT
CONCURRENT_WITH_END
AFTER_START
AFTER
AFTER_END

ActionRequiredBehaviorCode

Defines requiredness behavior for selecting an action or an action group See http://hl7.org/fhir/ValueSet/action-required-behavior

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
MUST
COULD
MUST_UNLESS_DOCUMENTED

ActionSelectionBehaviorCode

Defines selection behavior of a group See http://hl7.org/fhir/ValueSet/action-selection-behavior

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ANY
ALL
ALL_OR_NONE
EXACTLY_ONE
AT_MOST_ONE
ONE_OR_MORE

ActivityDefinition

Auto-generated from StructureDefinition for ActivityDefinition, last updated 2017-04-19T07:44:43.294+10:00. The definition of a specific activity to be taken, independent of any particular patient or context. See http://hl7.org/fhir/StructureDefinition/ActivityDefinition

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this activity definition (globally unique)
identifier[]	Identifier Additional identifier for the activity definition
version	String Business version of the activity definition
name	String Name for this activity definition (computer friendly)
title	String Name for this activity definition (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
description	Markdown Natural language description of the activity definition
purpose	Markdown Why this activity definition is defined
usage	String Describes the clinical usage of the asset
approval_date	Date When the activity definition was approved by publisher
last_review_date	Date When the activity definition was last reviewed
effective_period	Period When the activity definition is expected to be used
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for activity definition (if applicable)
topic[]	CodeableConcept E.g. Education, Treatment, Assessment, etc
contributor[]	Contributor A content contributor
contact[]	ContactDetail Contact details for the publisher
copyright	Markdown Use and/or publishing restrictions
related_artifact[]	RelatedArtifact Additional documentation, citations, etc
library[]	Reference Logic used by the asset
kind	ResourceTypeCode Kind of resource
code	CodeableConcept Detail type of activity
timing	TimingType
location	Reference Where it should happen
participant[]	Participant
product	Product
quantity	SimpleQuantity How much is administered/consumed/supplied
dosage[]	Dosage Detailed dosage instructions
body_site[]	CodeableConcept What part of body to perform on
transform	Reference Transform to apply the template
dynamic_value[]	DynamicValue

DynamicValue

Dynamic aspects of the definition

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
description	String Natural language description of the dynamic value
path	String The path to the element to be set dynamically
language	String Language of the expression
expression	String An expression that provides the dynamic value for the customization

Participant

Who should participate in the action

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	ActionParticipantTypeCode patient | practitioner | related-person
role	CodeableConcept E.g. Nurse, Surgeon, Parent, etc

Product

What's administered/supplied

Fields
Union field product. product can be only one of the following:
reference	Reference
codeable_concept	CodeableConcept

TimingType

When activity is to occur

Fields
Union field timing. timing can be only one of the following:
timing_value	Timing
date_time	DateTime
period	Period
range	Range

Address

Auto-generated from StructureDefinition for Address, last updated 2017-04-19T07:44:43.294+10:00. An address expressed using postal conventions (as opposed to GPS or other location definition formats). See http://hl7.org/fhir/StructureDefinition/Address

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
use	AddressUseCode home | work | temp | old - purpose of this address
type	AddressTypeCode postal | physical | both
text	String Text representation of the address
line[]	String Street name, number, direction & P.O. Box etc.
city	String Name of city, town etc.
district	String District name (aka county)
state	String Sub-unit of country (abbreviations ok)
postal_code	String Postal code for area
country	String Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Period Time period when address was/is in use

AddressTypeCode

The type of an address (physical / postal) See http://hl7.org/fhir/ValueSet/address-type

Fields
value	Value
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
POSTAL
PHYSICAL
BOTH

AddressUseCode

The use of an address See http://hl7.org/fhir/ValueSet/address-use

Fields
value	Value
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
HOME
WORK
TEMP
OLD

AdministrativeGenderCode

The gender of a person used for administrative purposes. See http://hl7.org/fhir/ValueSet/administrative-gender

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
MALE
FEMALE
OTHER
UNKNOWN

AdverseEvent

Auto-generated from StructureDefinition for AdverseEvent, last updated 2017-04-19T07:44:43.294+10:00. Medical care, research study or other healthcare event causing physical injury. See http://hl7.org/fhir/StructureDefinition/AdverseEvent

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Business identifier for the event
category	AdverseEventCategoryCode AE | PAE An adverse event is an event that caused harm to a patient, an adverse reaction is a something that is a subject-specific event that is a result of an exposure to a medication, food, device or environmental substance, a potential adverse event is something that occurred and that could have caused harm to a patient but did not
type	CodeableConcept actual | potential
subject	Reference Subject or group impacted by event
date	DateTime When the event occurred
reaction[]	Reference Adverse Reaction Events linked to exposure to substance
location	Reference Location where adverse event occurred
seriousness	CodeableConcept Mild | Moderate | Severe
outcome	CodeableConcept resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
recorder	Reference Who recorded the adverse event
event_participant	Reference Who was involved in the adverse event or the potential adverse event
description	String Description of the adverse event
suspect_entity[]	SuspectEntity
subject_medical_history[]	Reference AdverseEvent.subjectMedicalHistory
reference_document[]	Reference AdverseEvent.referenceDocument
study[]	Reference AdverseEvent.study

SuspectEntity

The suspected agent causing the adverse event

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
instance	Reference Refers to the specific entity that caused the adverse event
causality	AdverseEventCausalityCode causality1 | causality2
causality_assessment	CodeableConcept assess1 | assess2
causality_product_relatedness	String AdverseEvent.suspectEntity.causalityProductRelatedness
causality_method	CodeableConcept method1 | method2
causality_author	Reference AdverseEvent.suspectEntity.causalityAuthor
causality_result	CodeableConcept result1 | result2

AdverseEventCategoryCode

Overall categorization of the event, e.g. real or potential See http://hl7.org/fhir/ValueSet/adverse-event-category

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
AE
PAE

AdverseEventCausalityCode

TODO See http://hl7.org/fhir/ValueSet/adverse-event-causality

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CAUSALITY1
CAUSALITY2

Age

Auto-generated from StructureDefinition for Age, last updated 2017-04-19T07:44:43.294+10:00. A duration of time during which an organism (or a process) has existed. See http://hl7.org/fhir/StructureDefinition/Age

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
value	Decimal Numerical value (with implicit precision)
comparator	QuantityComparatorCode < | <= | >= | > - how to understand the value
unit	String Unit representation
system	Uri System that defines coded unit form
code	Code Coded form of the unit

AggregationModeCode

How resource references can be aggregated. See http://hl7.org/fhir/ValueSet/resource-aggregation-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CONTAINED
REFERENCED
BUNDLED

AllergyIntolerance

Auto-generated from StructureDefinition for AllergyIntolerance, last updated 2017-04-19T07:44:43.294+10:00. Allergy or Intolerance (generally: Risk of adverse reaction to a substance). See http://hl7.org/fhir/StructureDefinition/AllergyIntolerance

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External ids for this item
clinical_status	AllergyIntoleranceClinicalStatusCode active | inactive | resolved
verification_status	AllergyIntoleranceVerificationStatusCode unconfirmed | confirmed | refuted | entered-in-error
type	AllergyIntoleranceTypeCode allergy | intolerance - Underlying mechanism (if known)
category[]	AllergyIntoleranceCategoryCode food | medication | environment | biologic
criticality	AllergyIntoleranceCriticalityCode low | high | unable-to-assess
code	CodeableConcept Code that identifies the allergy or intolerance
patient	Reference Who the sensitivity is for
onset	Onset
asserted_date	DateTime Date record was believed accurate
recorder	Reference Who recorded the sensitivity
asserter	Reference Source of the information about the allergy
last_occurrence	DateTime Date(/time) of last known occurrence of a reaction
note[]	Annotation Additional text not captured in other fields
reaction[]	Reaction

Onset

When allergy or intolerance was identified

Fields
Union field onset. onset can be only one of the following:
date_time	DateTime
age	Age
period	Period
range	Range
string_value	String

Reaction

Adverse Reaction Events linked to exposure to substance

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
substance	CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
manifestation[]	CodeableConcept Clinical symptoms/signs associated with the Event
description	String Description of the event as a whole
onset	DateTime Date(/time) when manifestations showed
severity	AllergyIntoleranceSeverityCode mild | moderate | severe (of event as a whole)
exposure_route	CodeableConcept How the subject was exposed to the substance
note[]	Annotation Text about event not captured in other fields

AllergyIntoleranceCategoryCode

Category of an identified substance. See http://hl7.org/fhir/ValueSet/allergy-intolerance-category

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
FOOD
MEDICATION
ENVIRONMENT
BIOLOGIC

AllergyIntoleranceClinicalStatusCode

The clinical status of the allergy or intolerance. See http://hl7.org/fhir/ValueSet/allergy-clinical-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
INACTIVE
RESOLVED

AllergyIntoleranceCriticalityCode

Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. See http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
LOW
HIGH
UNABLE_TO_ASSESS

AllergyIntoleranceSeverityCode

Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. See http://hl7.org/fhir/ValueSet/reaction-event-severity

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
MILD
MODERATE
SEVERE

AllergyIntoleranceTypeCode

Identification of the underlying physiological mechanism for a Reaction Risk. See http://hl7.org/fhir/ValueSet/allergy-intolerance-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ALLERGY
INTOLERANCE

AllergyIntoleranceVerificationStatusCode

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. See http://hl7.org/fhir/ValueSet/allergy-verification-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
UNCONFIRMED
CONFIRMED
REFUTED
ENTERED_IN_ERROR

Annotation

Auto-generated from StructureDefinition for Annotation, last updated 2017-04-19T07:44:43.294+10:00. Text node with attribution. See http://hl7.org/fhir/StructureDefinition/Annotation

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
author	Author
time	DateTime When the annotation was made
text	String The annotation - text content

Author

Individual responsible for the annotation

Fields
Union field author. author can be only one of the following:
reference	Reference
string_value	String

Appointment

Auto-generated from StructureDefinition for Appointment, last updated 2017-04-19T07:44:43.294+10:00. A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). See http://hl7.org/fhir/StructureDefinition/Appointment

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Ids for this item
status	AppointmentStatusCode proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
service_category	CodeableConcept A broad categorisation of the service that is to be performed during this appointment
service_type[]	CodeableConcept The specific service that is to be performed during this appointment
specialty[]	CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
appointment_type	CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
reason[]	CodeableConcept Reason this appointment is scheduled
indication[]	Reference Reason the appointment is to takes place (resource)
priority	UnsignedInt Used to make informed decisions if needing to re-prioritize
description	String Shown on a subject line in a meeting request, or appointment list
supporting_information[]	Reference Additional information to support the appointment
start	Instant When appointment is to take place
end	Instant When appointment is to conclude
minutes_duration	PositiveInt Can be less than start/end (e.g. estimate)
slot[]	Reference The slots that this appointment is filling
created	DateTime The date that this appointment was initially created
comment	String Additional comments
incoming_referral[]	Reference The ReferralRequest provided as information to allocate to the Encounter
participant[]	Participant
requested_period[]	Period Potential date/time interval(s) requested to allocate the appointment within

Participant

Participants involved in appointment

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type[]	CodeableConcept Role of participant in the appointment
actor	Reference Person, Location/HealthcareService or Device
required	ParticipantRequiredCode required | optional | information-only
status	ParticipationStatusCode accepted | declined | tentative | needs-action

AppointmentResponse

Auto-generated from StructureDefinition for AppointmentResponse, last updated 2017-04-19T07:44:43.294+10:00. A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. See http://hl7.org/fhir/StructureDefinition/AppointmentResponse

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Ids for this item
appointment	Reference Appointment this response relates to
start	Instant Time from appointment, or requested new start time
end	Instant Time from appointment, or requested new end time
participant_type[]	CodeableConcept Role of participant in the appointment
actor	Reference Person, Location/HealthcareService or Device
participant_status	ParticipationStatusCode accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
comment	String Additional comments

AppointmentStatusCode

The free/busy status of an appointment. See http://hl7.org/fhir/ValueSet/appointmentstatus

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PROPOSED
PENDING
BOOKED
ARRIVED
FULFILLED
CANCELLED
NOSHOW
ENTERED_IN_ERROR

AssertionDirectionTypeCode

The type of direction to use for assertion. See http://hl7.org/fhir/ValueSet/assert-direction-codes

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
RESPONSE
REQUEST

AssertionOperatorTypeCode

The type of operator to use for assertion. See http://hl7.org/fhir/ValueSet/assert-operator-codes

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
EQUALS
NOTEQUALS
IN
NOTIN
GREATERTHAN
LESSTHAN
EMPTY
NOTEMPTY
CONTAINS
NOTCONTAINS
EVAL

AssertionResponseTypesCode

The type of response code to use for assertion. See http://hl7.org/fhir/ValueSet/assert-response-code-types

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
OKAY
CREATED
NOCONTENT
NOTMODIFIED
BAD
FORBIDDEN
NOTFOUND
METHODNOTALLOWED
CONFLICT
GONE
PRECONDITIONFAILED
UNPROCESSABLE

Attachment

Auto-generated from StructureDefinition for Attachment, last updated 2017-04-19T07:44:43.294+10:00. Content in a format defined elsewhere. See http://hl7.org/fhir/StructureDefinition/Attachment

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
content_type	MimeTypeCode Mime type of the content, with charset etc.
language	LanguageCode Human language of the content (BCP-47)
data	Base64Binary Data inline, base64ed
url	Uri Uri where the data can be found
size	UnsignedInt Number of bytes of content (if url provided)
hash	Base64Binary Hash of the data (sha-1, base64ed)
title	String Label to display in place of the data
creation	DateTime Date attachment was first created

AuditEvent

Auto-generated from StructureDefinition for AuditEvent, last updated 2017-04-19T07:44:43.294+10:00. Event record kept for security purposes. See http://hl7.org/fhir/StructureDefinition/AuditEvent

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	Coding Type/identifier of event
subtype[]	Coding More specific type/id for the event
action	AuditEventActionCode Type of action performed during the event
recorded	Instant Time when the event occurred on source
outcome	AuditEventOutcomeCode Whether the event succeeded or failed
outcome_desc	String Description of the event outcome
purpose_of_event[]	CodeableConcept The purposeOfUse of the event
agent[]	Agent
source	Source
entity[]	Entity

Agent

Actor involved in the event

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
role[]	CodeableConcept Agent role in the event
reference	Reference Direct reference to resource
user_id	Identifier Unique identifier for the user
alt_id	String Alternative User id e.g. authentication
name	String Human-meaningful name for the agent
requestor	Boolean Whether user is initiator
location	Reference Where
policy[]	Uri Policy that authorized event
media	Coding Type of media
network	Network
purpose_of_use[]	CodeableConcept Reason given for this user

Network

Logical network location for application activity

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
address	String Identifier for the network access point of the user device
type	AuditEventAgentNetworkTypeCode The type of network access point

Entity

Data or objects used

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Specific instance of object
reference	Reference Specific instance of resource
type	Coding Type of entity involved
role	Coding What role the entity played
lifecycle	Coding Life-cycle stage for the entity
security_label[]	Coding Security labels on the entity
name	String Descriptor for entity
description	String Descriptive text
query	Base64Binary Query parameters
detail[]	Detail

Detail

Additional Information about the entity

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	String Name of the property
value	Base64Binary Property value

Source

Audit Event Reporter

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
site	String Logical source location within the enterprise
identifier	Identifier The identity of source detecting the event
type[]	Coding The type of source where event originated

AuditEventActionCode

Indicator for type of action performed during the event that generated the event See http://hl7.org/fhir/ValueSet/audit-event-action

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
C
R
U
D
E

AuditEventAgentNetworkTypeCode

The type of network access point of this agent in the audit event See http://hl7.org/fhir/ValueSet/network-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
MACHINE_NAME
IP_ADDRESS
TELEPHONE_NUMBER
EMAIL_ADDRESS
URI

AuditEventOutcomeCode

Indicates whether the event succeeded or failed See http://hl7.org/fhir/ValueSet/audit-event-outcome

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
SUCCESS
MINOR_FAILURE
SERIOUS_FAILURE
MAJOR_FAILURE

Base64Binary

Auto-generated from StructureDefinition for base64Binary, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type base64Binary. See http://hl7.org/fhir/StructureDefinition/base64Binary

Fields
value	bytes Primitive value for base64Binary
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Basic

Auto-generated from StructureDefinition for Basic, last updated 2017-04-19T07:44:43.294+10:00. Resource for non-supported content. See http://hl7.org/fhir/StructureDefinition/Basic

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business identifier
code	CodeableConcept Kind of Resource
subject	Reference Identifies the focus of this resource
created	Date When created
author	Reference Who created

Binary

Auto-generated from StructureDefinition for Binary, last updated 2017-04-19T07:44:43.294+10:00. Pure binary content defined by a format other than FHIR. See http://hl7.org/fhir/StructureDefinition/Binary

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
content_type	MimeTypeCode MimeType of the binary content
security_context	Reference Access Control Management
content	Base64Binary The actual content

BindingStrengthCode

Indication of the degree of conformance expectations associated with a binding. See http://hl7.org/fhir/ValueSet/binding-strength

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
REQUIRED
EXTENSIBLE
PREFERRED
EXAMPLE

BodySite

Auto-generated from StructureDefinition for BodySite, last updated 2017-04-19T07:44:43.294+10:00. Specific and identified anatomical location. See http://hl7.org/fhir/StructureDefinition/BodySite

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Bodysite identifier
active	Boolean Whether this body site record is in active use
code	CodeableConcept Named anatomical location
qualifier[]	CodeableConcept Modification to location code
description	String Anatomical location description
image[]	Attachment Attached images
patient	Reference Who this is about

Boolean

Auto-generated from StructureDefinition for boolean, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type boolean. See http://hl7.org/fhir/StructureDefinition/boolean

Fields
value	bool Primitive value for boolean
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Bundle

Auto-generated from StructureDefinition for Bundle, last updated 2017-04-19T07:44:43.294+10:00. Contains a collection of resources. See http://hl7.org/fhir/StructureDefinition/Bundle

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
identifier	Identifier Persistent identifier for the bundle
type	BundleTypeCode document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
total	UnsignedInt If search, the total number of matches
link[]	Link
entry[]	Entry
signature	Signature Digital Signature

Entry

Entry in the bundle - will have a resource, or information

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
link[]	Link Links related to this entry
full_url	Uri Absolute URL for resource (server address, or UUID/OID)
resource	ContainedResource A resource in the bundle
search	Search
request	Request
response	Response

Request

Transaction Related Information

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
method	HTTPVerbCode GET | POST | PUT | DELETE
url	Uri URL for HTTP equivalent of this entry
if_none_match	String For managing cache currency
if_modified_since	Instant For managing update contention
if_match	String For managing update contention
if_none_exist	String For conditional creates

Response

Transaction Related Information

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
status	String Status response code (text optional)
location	Uri The location, if the operation returns a location
etag	String The etag for the resource (if relevant)
last_modified	Instant Server's date time modified
outcome	ContainedResource OperationOutcome with hints and warnings (for batch/transaction)

Search

Search related information

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
mode	SearchEntryModeCode match | include | outcome - why this is in the result set
score	Decimal Search ranking (between 0 and 1)

Link

Links related to this Bundle

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
relation	String See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Uri Reference details for the link

BundleTypeCode

Indicates the purpose of a bundle - how it was intended to be used. See http://hl7.org/fhir/ValueSet/bundle-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DOCUMENT
MESSAGE
TRANSACTION
TRANSACTION_RESPONSE
BATCH
BATCH_RESPONSE
HISTORY
SEARCHSET
COLLECTION

CapabilityStatement

Auto-generated from StructureDefinition for CapabilityStatement, last updated 2017-04-19T07:44:43.294+10:00. A statement of system capabilities. See http://hl7.org/fhir/StructureDefinition/CapabilityStatement

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this capability statement (globally unique)
version	String Business version of the capability statement
name	String Name for this capability statement (computer friendly)
title	String Name for this capability statement (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the capability statement
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for capability statement (if applicable)
purpose	Markdown Why this capability statement is defined
copyright	Markdown Use and/or publishing restrictions
kind	CapabilityStatementKindCode instance | capability | requirements
instantiates[]	Uri Canonical URL of another capability statement this implements
software	Software
implementation	Implementation
fhir_version	Id FHIR Version the system uses
accept_unknown	UnknownContentCodeCode no | extensions | elements | both
format[]	MimeTypeCode formats supported (xml | json | ttl | mime type)
patch_format[]	MimeTypeCode Patch formats supported
implementation_guide[]	Uri Implementation guides supported
profile[]	Reference Profiles for use cases supported
rest[]	Rest
messaging[]	Messaging
document[]	Document

Document

Document definition

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
mode	DocumentModeCode producer | consumer
documentation	String Description of document support
profile	Reference Constraint on a resource used in the document

Implementation

If this describes a specific instance

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
description	String Describes this specific instance
url	Uri Base URL for the installation

Messaging

If messaging is supported

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
endpoint[]	Endpoint
reliable_cache	UnsignedInt Reliable Message Cache Length (min)
documentation	String Messaging interface behavior details
supported_message[]	SupportedMessage
event[]	Event

Endpoint

Where messages should be sent

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
protocol	Coding http | ftp | mllp +
address	Uri Network address or identifier of the end-point

Event

Declare support for this event

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	Coding Event type
category	MessageSignificanceCategoryCode Consequence | Currency | Notification
mode	EventCapabilityModeCode sender | receiver
focus	ResourceTypeCode Resource that's focus of message
request	Reference Profile that describes the request
response	Reference Profile that describes the response
documentation	String Endpoint-specific event documentation

SupportedMessage

Messages supported by this system

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
mode	EventCapabilityModeCode sender | receiver
definition	Reference Message supported by this system

Rest

If the endpoint is a RESTful one

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
mode	RestfulCapabilityModeCode client | server
documentation	String General description of implementation
security	Security
resource[]	Resource
interaction[]	SystemInteraction
search_param[]	SearchParam Search parameters for searching all resources
operation[]	Operation
compartment[]	Uri Compartments served/used by system

Operation

Definition of an operation or a custom query

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Name by which the operation/query is invoked
definition	Reference The defined operation/query

Resource

Resource served on the REST interface

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	ResourceTypeCode A resource type that is supported
profile	Reference Base System profile for all uses of resource
documentation	Markdown Additional information about the use of the resource type
interaction[]	ResourceInteraction
versioning	ResourceVersionPolicyCode no-version | versioned | versioned-update
read_history	Boolean Whether vRead can return past versions
update_create	Boolean If update can commit to a new identity
conditional_create	Boolean If allows/uses conditional create
conditional_read	ConditionalReadStatusCode not-supported | modified-since | not-match | full-support
conditional_update	Boolean If allows/uses conditional update
conditional_delete	ConditionalDeleteStatusCode not-supported | single | multiple - how conditional delete is supported
reference_policy[]	ReferenceHandlingPolicyCode literal | logical | resolves | enforced | local
search_include[]	String _include values supported by the server
search_rev_include[]	String _revinclude values supported by the server
search_param[]	SearchParam

ResourceInteraction

What operations are supported?

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	TypeRestfulInteractionCode read | vread | update | patch | delete | history-instance | history-type | create | search-type
documentation	String Anything special about operation behavior

SearchParam

Search parameters supported by implementation

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Name of search parameter
definition	Uri Source of definition for parameter
type	SearchParamTypeCode number | date | string | token | reference | composite | quantity | uri
documentation	String Server-specific usage

Security

Information about security of implementation

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
cors	Boolean Adds CORS Headers (http://enable-cors.org/)
service[]	CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
description	String General description of how security works
certificate[]	Certificate

Certificate

Certificates associated with security profiles

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	MimeTypeCode Mime type for certificates
blob	Base64Binary Actual certificate

SystemInteraction

What operations are supported?

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	SystemRestfulInteractionCode transaction | batch | search-system | history-system
documentation	String Anything special about operation behavior

Software

Software that is covered by this capability statement

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String A name the software is known by
version	String Version covered by this statement
release_date	DateTime Date this version released

CapabilityStatementKindCode

How a capability statement is intended to be used. See http://hl7.org/fhir/ValueSet/capability-statement-kind

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
INSTANCE
CAPABILITY
REQUIREMENTS

CarePlan

Auto-generated from StructureDefinition for CarePlan, last updated 2017-04-19T07:44:43.294+10:00. Healthcare plan for patient or group. See http://hl7.org/fhir/StructureDefinition/CarePlan

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Ids for this plan
definition[]	Reference Protocol or definition
based_on[]	Reference Fulfills care plan
replaces[]	Reference CarePlan replaced by this CarePlan
part_of[]	Reference Part of referenced CarePlan
status	CarePlanStatusCode draft | active | suspended | completed | entered-in-error | cancelled | unknown
intent	CarePlanIntentCode proposal | plan | order | option
category[]	CodeableConcept Type of plan
title	String Human-friendly name for the CarePlan
description	String Summary of nature of plan
subject	Reference Who care plan is for
context	Reference Created in context of
period	Period Time period plan covers
author[]	Reference Who is responsible for contents of the plan
care_team[]	Reference Who's involved in plan?
addresses[]	Reference Health issues this plan addresses
supporting_info[]	Reference Information considered as part of plan
goal[]	Reference Desired outcome of plan
activity[]	Activity
note[]	Annotation Comments about the plan

Activity

Action to occur as part of plan

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
outcome_codeable_concept[]	CodeableConcept Results of the activity
outcome_reference[]	Reference Appointment, Encounter, Procedure, etc.
progress[]	Annotation Comments about the activity status/progress
reference	Reference Activity details defined in specific resource
detail	Detail

Detail

In-line definition of activity

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
category	CodeableConcept diet | drug | encounter | observation | procedure | supply | other
definition	Reference Protocol or definition
code	CodeableConcept Detail type of activity
reason_code[]	CodeableConcept Why activity should be done or why activity was prohibited
reason_reference[]	Reference Condition triggering need for activity
goal[]	Reference Goals this activity relates to
status	CarePlanActivityStatusCode not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown
status_reason	String Reason for current status
prohibited	Boolean Do NOT do
scheduled	Scheduled
location	Reference Where it should happen
performer[]	Reference Who will be responsible?
product	Product
daily_amount	SimpleQuantity How to consume/day?
quantity	SimpleQuantity How much to administer/supply/consume
description	String Extra info describing activity to perform

Product

What is to be administered/supplied

Fields
Union field product. product can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Scheduled

When activity is to occur

Fields
Union field scheduled. scheduled can be only one of the following:
timing	Timing
period	Period
string_value	String

CarePlanActivityStatusCode

Indicates where the activity is at in its overall life cycle. See http://hl7.org/fhir/ValueSet/care-plan-activity-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NOT_STARTED
SCHEDULED
IN_PROGRESS
ON_HOLD
COMPLETED
CANCELLED
UNKNOWN

CarePlanIntentCode

Codes indicating the degree of authority/intentionality associated with a care plan See http://hl7.org/fhir/ValueSet/care-plan-intent

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PROPOSAL
PLAN
ORDER
OPTION

CarePlanStatusCode

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. See http://hl7.org/fhir/ValueSet/care-plan-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DRAFT
ACTIVE
SUSPENDED
COMPLETED
ENTERED_IN_ERROR
CANCELLED
UNKNOWN

CareTeam

Auto-generated from StructureDefinition for CareTeam, last updated 2017-04-19T07:44:43.294+10:00. Planned participants in the coordination and delivery of care for a patient or group. See http://hl7.org/fhir/StructureDefinition/CareTeam

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Ids for this team
status	CareTeamStatusCode proposed | active | suspended | inactive | entered-in-error
category[]	CodeableConcept Type of team
name	String Name of the team, such as crisis assessment team
subject	Reference Who care team is for
context	Reference Encounter or episode associated with CareTeam
period	Period Time period team covers
participant[]	Participant
reason_code[]	CodeableConcept Why the care team exists
reason_reference[]	Reference Why the care team exists
managing_organization[]	Reference Organization responsible for the care team
note[]	Annotation Comments made about the CareTeam

Participant

Members of the team

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
role	CodeableConcept Type of involvement
member	Reference Who is involved
on_behalf_of	Reference Organization of the practitioner
period	Period Time period of participant

CareTeamStatusCode

Indicates the status of the care team. See http://hl7.org/fhir/ValueSet/care-team-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PROPOSED
ACTIVE
SUSPENDED
INACTIVE
ENTERED_IN_ERROR

ChargeItem

Auto-generated from StructureDefinition for ChargeItem, last updated 2017-04-19T07:44:43.294+10:00. Item containing charge code(s) associated with the provision of healthcare provider products. See http://hl7.org/fhir/StructureDefinition/ChargeItem

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Business Identifier for item
definition[]	Uri Defining information about the code of this charge item
status	ChargeItemStatusCode planned | billable | not-billable | aborted | billed | entered-in-error | unknown
part_of[]	Reference Part of referenced ChargeItem
code	CodeableConcept A code that identifies the charge, like a billing code
subject	Reference Individual service was done for/to
context	Reference Encounter / Episode associated with event
occurrence	Occurrence
participant[]	Participant
performing_organization	Reference Organization providing the charged sevice
requesting_organization	Reference Organization requesting the charged service
quantity	Quantity Quantity of which the charge item has been serviced
bodysite[]	CodeableConcept Anatomical location, if relevant
factor_override	Decimal Factor overriding the associated rules
price_override	Money Price overriding the associated rules
override_reason	String Reason for overriding the list price/factor
enterer	Reference Individual who was entering
entered_date	DateTime Date the charge item was entered
reason[]	CodeableConcept Why was the charged service rendered?
service[]	Reference Which rendered service is being charged?
account[]	Reference Account to place this charge
note[]	Annotation Comments made about the ChargeItem
supporting_information[]	Reference Further information supporting the this charge

Occurrence

When the charged service was applied

Fields
Union field occurrence. occurrence can be only one of the following:
date_time	DateTime
period	Period
timing	Timing

Participant

Who performed charged service

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
role	CodeableConcept What type of performance was done
actor	Reference Individual who was performing

ChargeItemStatusCode

Codes identifying the stage lifecycle stage of a ChargeItem See http://hl7.org/fhir/ValueSet/chargeitem-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PLANNED
BILLABLE
NOT_BILLABLE
ABORTED
BILLED
ENTERED_IN_ERROR
UNKNOWN

Claim

Auto-generated from StructureDefinition for Claim, last updated 2017-04-19T07:44:43.294+10:00. Claim, Pre-determination or Pre-authorization. See http://hl7.org/fhir/StructureDefinition/Claim

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Claim number
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
type	CodeableConcept Type or discipline
sub_type[]	CodeableConcept Finer grained claim type information
use	UseCode complete | proposed | exploratory | other
patient	Reference The subject of the Products and Services
billable_period	Period Period for charge submission
created	DateTime Creation date
enterer	Reference Author
insurer	Reference Target
provider	Reference Responsible provider
organization	Reference Responsible organization
priority	CodeableConcept Desired processing priority
funds_reserve	CodeableConcept Funds requested to be reserved
related[]	RelatedClaim
prescription	Reference Prescription authorizing services or products
original_prescription	Reference Original prescription if superceded by fulfiller
payee	Payee
referral	Reference Treatment Referral
facility	Reference Servicing Facility
care_team[]	CareTeam
information[]	SpecialCondition
diagnosis[]	Diagnosis
procedure[]	Procedure
insurance[]	Insurance
accident	Accident
employment_impacted	Period Period unable to work
hospitalization	Period Period in hospital
item[]	Item
total	Money Total claim cost

Accident

Details about an accident

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
date	Date When the accident occurred see information codes see information codes
type	CodeableConcept The nature of the accident
location	Location

Location

Accident Place

Fields
Union field location. location can be only one of the following:
address	Address
reference	Reference

CareTeam

Members of the care team

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Number to covey order of careTeam
provider	Reference Provider individual or organization
responsible	Boolean Billing provider
role	CodeableConcept Role on the team
qualification	CodeableConcept Type, classification or Specialization

Diagnosis

List of Diagnosis

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Number to covey order of diagnosis
diagnosis	DiagnosisType
type[]	CodeableConcept Timing or nature of the diagnosis
package_code	CodeableConcept Package billing code

DiagnosisType

Patient's diagnosis

Fields
Union field diagnosis. diagnosis can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Insurance

Insurance or medical plan

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Service instance identifier
focal	Boolean Is the focal Coverage
coverage	Reference Insurance information
business_arrangement	String Business agreement
pre_auth_ref[]	String Pre-Authorization/Determination Reference
claim_response	Reference Adjudication results

Item

Goods and Services

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Service instance
care_team_link_id[]	PositiveInt Applicable careTeam members
diagnosis_link_id[]	PositiveInt Applicable diagnoses
procedure_link_id[]	PositiveInt Applicable procedures
information_link_id[]	PositiveInt Applicable exception and supporting information
revenue	CodeableConcept Revenue or cost center code
category	CodeableConcept Type of service or product
service	CodeableConcept Billing Code
modifier[]	CodeableConcept Service/Product billing modifiers
program_code[]	CodeableConcept Program specific reason for item inclusion
serviced	Serviced
location	Location
quantity	SimpleQuantity Count of Products or Services
unit_price	Money Fee, charge or cost per point
factor	Decimal Price scaling factor
net	Money Total item cost
udi[]	Reference Unique Device Identifier
body_site	CodeableConcept Service Location
sub_site[]	CodeableConcept Service Sub-location
encounter[]	Reference Encounters related to this billed item
detail[]	Detail

Detail

Additional items

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Service instance
revenue	CodeableConcept Revenue or cost center code
category	CodeableConcept Type of service or product
service	CodeableConcept Billing Code
modifier[]	CodeableConcept Service/Product billing modifiers
program_code[]	CodeableConcept Program specific reason for item inclusion
quantity	SimpleQuantity Count of Products or Services
unit_price	Money Fee, charge or cost per point
factor	Decimal Price scaling factor
net	Money Total additional item cost
udi[]	Reference Unique Device Identifier
sub_detail[]	SubDetail

SubDetail

Additional items

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Service instance
revenue	CodeableConcept Revenue or cost center code
category	CodeableConcept Type of service or product
service	CodeableConcept Billing Code
modifier[]	CodeableConcept Service/Product billing modifiers
program_code[]	CodeableConcept Program specific reason for item inclusion
quantity	SimpleQuantity Count of Products or Services
unit_price	Money Fee, charge or cost per point
factor	Decimal Price scaling factor
net	Money Net additional item cost
udi[]	Reference Unique Device Identifier

Location

Place of service

Fields
Union field location. location can be only one of the following:
codeable_concept	CodeableConcept
address	Address
reference	Reference

Serviced

Date or dates of Service

Fields
Union field serviced. serviced can be only one of the following:
date	Date
period	Period

Payee

Party to be paid any benefits payable

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept Type of party: Subscriber, Provider, other
resource_type	Coding organization | patient | practitioner | relatedperson
party	Reference Party to receive the payable

Procedure

Procedures performed

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Procedure sequence for reference
date	DateTime When the procedure was performed
procedure	ProcedureType

ProcedureType

Patient's list of procedures performed

Fields
Union field procedure. procedure can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

RelatedClaim

Related Claims which may be revelant to processing this claimn

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
claim	Reference Reference to the related claim
relationship	CodeableConcept How the reference claim is related
reference	Identifier Related file or case reference

SpecialCondition

Exceptions, special considerations, the condition, situation, prior or concurrent issues

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Information instance identifier
category	CodeableConcept General class of information
code	CodeableConcept Type of information
timing	TimingType
value	Value
reason	CodeableConcept Reason associated with the information

TimingType

When it occurred

Fields
Union field timing. timing can be only one of the following:
date	Date
period	Period

Value

Additional Data or supporting information

Fields
Union field value. value can be only one of the following:
string_value	String
quantity	Quantity
attachment	Attachment
reference	Reference

ClaimResponse

Auto-generated from StructureDefinition for ClaimResponse, last updated 2017-04-19T07:44:43.294+10:00. Remittance resource. See http://hl7.org/fhir/StructureDefinition/ClaimResponse

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Response number
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
patient	Reference The subject of the Products and Services
created	DateTime Creation date
insurer	Reference Insurance issuing organization
request_provider	Reference Responsible practitioner
request_organization	Reference Responsible organization
request	Reference Id of resource triggering adjudication
outcome	CodeableConcept complete | error | partial
disposition	String Disposition Message
payee_type	CodeableConcept Party to be paid any benefits payable
item[]	Item
add_item[]	AddedItem
error[]	Error
total_cost	Money Total Cost of service from the Claim
unalloc_deductable	Money Unallocated deductible
total_benefit	Money Total benefit payable for the Claim
payment	Payment
reserved	Coding Funds reserved status
form	CodeableConcept Printed Form Identifier
process_note[]	Note
communication_request[]	Reference Request for additional information
insurance[]	Insurance

AddedItem

Insurer added line items

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence_link_id[]	PositiveInt Service instances
revenue	CodeableConcept Revenue or cost center code
category	CodeableConcept Type of service or product
service	CodeableConcept Group, Service or Product
modifier[]	CodeableConcept Service/Product billing modifiers
fee	Money Professional fee or Product charge
note_number[]	PositiveInt List of note numbers which apply
adjudication[]	Adjudication Added items adjudication
detail[]	AddedItemsDetail

AddedItemsDetail

Added items details

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
revenue	CodeableConcept Revenue or cost center code
category	CodeableConcept Type of service or product
service	CodeableConcept Service or Product
modifier[]	CodeableConcept Service/Product billing modifiers
fee	Money Professional fee or Product charge
note_number[]	PositiveInt List of note numbers which apply
adjudication[]	Adjudication Added items detail adjudication

Error

Processing errors

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence_link_id	PositiveInt Item sequence number
detail_sequence_link_id	PositiveInt Detail sequence number
subdetail_sequence_link_id	PositiveInt Subdetail sequence number
code	CodeableConcept Error code detailing processing issues

Insurance

Insurance or medical plan

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Service instance identifier
focal	Boolean Is the focal Coverage
coverage	Reference Insurance information
business_arrangement	String Business agreement
pre_auth_ref[]	String Pre-Authorization/Determination Reference
claim_response	Reference Adjudication results

Item

Line items

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence_link_id	PositiveInt Service instance
note_number[]	PositiveInt List of note numbers which apply
adjudication[]	Adjudication
detail[]	ItemDetail

Adjudication

Adjudication details

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
category	CodeableConcept Adjudication category such as co-pay, eligible, benefit, etc.
reason	CodeableConcept Explanation of Adjudication outcome
amount	Money Monetary amount
value	Decimal Non-monetary value

ItemDetail

Detail line items

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence_link_id	PositiveInt Service instance
note_number[]	PositiveInt List of note numbers which apply
adjudication[]	Adjudication Detail level adjudication details
sub_detail[]	SubDetail

SubDetail

Subdetail line items

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence_link_id	PositiveInt Service instance
note_number[]	PositiveInt List of note numbers which apply
adjudication[]	Adjudication Subdetail level adjudication details

Note

Processing notes

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
number	PositiveInt Sequence Number for this note
type	CodeableConcept display | print | printoper
text	String Note explanatory text
language	CodeableConcept Language if different from the resource

Payment

Payment details, if paid

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept Partial or Complete
adjustment	Money Payment adjustment for non-Claim issues
adjustment_reason	CodeableConcept Explanation for the non-claim adjustment
date	Date Expected data of Payment
amount	Money Payable amount after adjustment
identifier	Identifier Identifier of the payment instrument

ClinicalImpression

Auto-generated from StructureDefinition for ClinicalImpression, last updated 2017-04-19T07:44:43.294+10:00. A clinical assessment performed when planning treatments and management strategies for a patient. See http://hl7.org/fhir/StructureDefinition/ClinicalImpression

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business identifier
status	ClinicalImpressionStatusCode draft | completed | entered-in-error
code	CodeableConcept Kind of assessment performed
description	String Why/how the assessment was performed
subject	Reference Patient or group assessed
context	Reference Encounter or Episode created from
effective	Effective
date	DateTime When the assessment was documented
assessor	Reference The clinician performing the assessment
previous	Reference Reference to last assessment
problem[]	Reference Relevant impressions of patient state
investigation[]	Investigation
protocol[]	Uri Clinical Protocol followed
summary	String Summary of the assessment
finding[]	Finding
prognosis_codeable_concept[]	CodeableConcept Estimate of likely outcome
prognosis_reference[]	Reference RiskAssessment expressing likely outcome
action[]	Reference Action taken as part of assessment procedure
note[]	Annotation Comments made about the ClinicalImpression

Effective

Time of assessment

Fields
Union field effective. effective can be only one of the following:
date_time	DateTime
period	Period

Finding

Possible or likely findings and diagnoses

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
item	Item
basis	String Which investigations support finding

Item

What was found

Fields
Union field item. item can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Investigation

One or more sets of investigations (signs, symptions, etc.)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	CodeableConcept A name/code for the set
item[]	Reference Record of a specific investigation

ClinicalImpressionStatusCode

The workflow state of a clinical impression. See http://hl7.org/fhir/ValueSet/clinical-impression-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DRAFT
COMPLETED
ENTERED_IN_ERROR

Code

Auto-generated from StructureDefinition for code, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type code. See http://hl7.org/fhir/StructureDefinition/code

Fields
value	string Primitive value for code
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

CodeSystem

Auto-generated from StructureDefinition for CodeSystem, last updated 2017-04-19T07:44:43.294+10:00. A set of codes drawn from one or more code systems. See http://hl7.org/fhir/StructureDefinition/CodeSystem

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this code system (globally unique) (Coding.system)
identifier	Identifier Additional identifier for the code system
version	String Business version of the code system (Coding.version)
name	String Name for this code system (computer friendly)
title	String Name for this code system (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the code system
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for code system (if applicable)
purpose	Markdown Why this code system is defined
copyright	Markdown Use and/or publishing restrictions
case_sensitive	Boolean If code comparison is case sensitive
value_set	Uri Canonical URL for value set with entire code system
hierarchy_meaning	CodeSystemHierarchyMeaningCode grouped-by | is-a | part-of | classified-with
compositional	Boolean If code system defines a post-composition grammar
version_needed	Boolean If definitions are not stable
content	CodeSystemContentModeCode not-present | example | fragment | complete
count	UnsignedInt Total concepts in the code system
filter[]	Filter
property[]	Property
concept[]	ConceptDefinition

ConceptDefinition

Concepts in the code system

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	Code Code that identifies concept
display	String Text to display to the user
definition	String Formal definition
designation[]	Designation
property[]	ConceptProperty
concept[]	ConceptDefinition Child Concepts (is-a/contains/categorizes)

ConceptProperty

Property value for the concept

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	Code Reference to CodeSystem.property.code
value	Value

Value

Value of the property for this concept

Fields
Union field value. value can be only one of the following:
code	Code
coding	Coding
string_value	String
integer	Integer
boolean	Boolean
date_time	DateTime

Designation

Additional representations for the concept

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
language	LanguageCode Human language of the designation
use	Coding Details how this designation would be used
value	String The text value for this designation

Filter

Filter that can be used in a value set

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	Code Code that identifies the filter
description	String How or why the filter is used
operator[]	FilterOperatorCode Operators that can be used with filter
value	String What to use for the value

Property

Additional information supplied about each concept

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	Code Identifies the property on the concepts, and when referred to in operations
uri	Uri Formal identifier for the property
description	String Why the property is defined, and/or what it conveys
type	PropertyTypeCode code | Coding | string | integer | boolean | dateTime

CodeSystemContentModeCode

How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource See http://hl7.org/fhir/ValueSet/codesystem-content-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NOT_PRESENT
EXAMPLE
FRAGMENT
COMPLETE

CodeSystemHierarchyMeaningCode

The meaning of the hierarchy of concepts in a code system See http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
GROUPED_BY
IS_A
PART_OF
CLASSIFIED_WITH

CodeableConcept

Auto-generated from StructureDefinition for CodeableConcept, last updated 2017-04-19T07:44:43.294+10:00. Concept - reference to a terminology or just text. See http://hl7.org/fhir/StructureDefinition/CodeableConcept

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
coding[]	Coding Code defined by a terminology system
text	String Plain text representation of the concept

Coding

Auto-generated from StructureDefinition for Coding, last updated 2017-04-19T07:44:43.294+10:00. A reference to a code defined by a terminology system. See http://hl7.org/fhir/StructureDefinition/Coding

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
system	Uri Identity of the terminology system
version	String Version of the system - if relevant
code	Code Symbol in syntax defined by the system
display	String Representation defined by the system
user_selected	Boolean If this coding was chosen directly by the user

Communication

Auto-generated from StructureDefinition for Communication, last updated 2017-04-19T07:44:43.294+10:00. A record of information transmitted from a sender to a receiver. See http://hl7.org/fhir/StructureDefinition/Communication

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Unique identifier
definition[]	Reference Instantiates protocol or definition
based_on[]	Reference Request fulfilled by this communication
part_of[]	Reference Part of this action
status	EventStatusCode preparation | in-progress | suspended | aborted | completed | entered-in-error
not_done	Boolean Communication did not occur
not_done_reason	CodeableConcept Why communication did not occur
category[]	CodeableConcept Message category
medium[]	CodeableConcept A channel of communication
subject	Reference Focus of message
recipient[]	Reference Message recipient
topic[]	Reference Focal resources
context	Reference Encounter or episode leading to message
sent	DateTime When sent
received	DateTime When received
sender	Reference Message sender
reason_code[]	CodeableConcept Indication for message
reason_reference[]	Reference Why was communication done?
payload[]	Payload
note[]	Annotation Comments made about the communication

Payload

Message payload

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
content	Content

Content

Message part content

Fields
Union field content. content can be only one of the following:
string_value	String
attachment	Attachment
reference	Reference

CommunicationRequest

Auto-generated from StructureDefinition for CommunicationRequest, last updated 2017-04-19T07:44:43.294+10:00. A request for information to be sent to a receiver. See http://hl7.org/fhir/StructureDefinition/CommunicationRequest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Unique identifier
based_on[]	Reference Fulfills plan or proposal
replaces[]	Reference Request(s) replaced by this request
group_identifier	Identifier Composite request this is part of
status	RequestStatusCode draft | active | suspended | cancelled | completed | entered-in-error | unknown
category[]	CodeableConcept Message category
priority	RequestPriorityCode Message urgency
medium[]	CodeableConcept A channel of communication
subject	Reference Focus of message
recipient[]	Reference Message recipient
topic[]	Reference Focal resources
context	Reference Encounter or episode leading to message
payload[]	Payload
occurrence	Occurrence
authored_on	DateTime When request transitioned to being actionable
sender	Reference Message sender
requester	Requester
reason_code[]	CodeableConcept Why is communication needed?
reason_reference[]	Reference Why is communication needed?
note[]	Annotation Comments made about communication request

Occurrence

When scheduled

Fields
Union field occurrence. occurrence can be only one of the following:
date_time	DateTime
period	Period

Payload

Message payload

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
content	Content

Content

Message part content

Fields
Union field content. content can be only one of the following:
string_value	String
attachment	Attachment
reference	Reference

Requester

Who/what is requesting service

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
agent	Reference Individual making the request
on_behalf_of	Reference Organization agent is acting for

CompartmentDefinition

Auto-generated from StructureDefinition for CompartmentDefinition, last updated 2017-04-19T07:44:43.294+10:00. Compartment Definition for a resource. See http://hl7.org/fhir/StructureDefinition/CompartmentDefinition

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this compartment definition (globally unique)
name	String Name for this compartment definition (computer friendly)
title	String Name for this compartment definition (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the compartment definition
purpose	Markdown Why this compartment definition is defined
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for compartment definition (if applicable)
code	CompartmentTypeCode Patient | Encounter | RelatedPerson | Practitioner | Device
search	Boolean Whether the search syntax is supported
resource[]	Resource

Resource

How a resource is related to the compartment

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	ResourceTypeCode Name of resource type
param[]	String Search Parameter Name, or chained parameters
documentation	String Additional documentation about the resource and compartment

CompartmentTypeCode

Which compartment a compartment definition describes See http://hl7.org/fhir/ValueSet/compartment-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PATIENT
ENCOUNTER
RELATEDPERSON
PRACTITIONER
DEVICE

Composition

Auto-generated from StructureDefinition for Composition, last updated 2017-04-19T07:44:43.294+10:00. A set of resources composed into a single coherent clinical statement with clinical attestation. See http://hl7.org/fhir/StructureDefinition/Composition

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Logical identifier of composition (version-independent)
status	CompositionStatusCode preliminary | final | amended | entered-in-error
type	CodeableConcept Kind of composition (LOINC if possible)
class_value	CodeableConcept Categorization of Composition
subject	Reference Who and/or what the composition is about
encounter	Reference Context of the Composition
date	DateTime Composition editing time
author[]	Reference Who and/or what authored the composition
title	String Human Readable name/title
confidentiality	ConfidentialityClassificationCode As defined by affinity domain
attester[]	Attester
custodian	Reference Organization which maintains the composition
relates_to[]	RelatesTo
event[]	Event
section[]	Section

Attester

Attests to accuracy of composition

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
mode[]	CompositionAttestationModeCode personal | professional | legal | official
time	DateTime When the composition was attested
party	Reference Who attested the composition

Event

The clinical service(s) being documented

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code[]	CodeableConcept Code(s) that apply to the event being documented
period	Period The period covered by the documentation
detail[]	Reference The event(s) being documented

RelatesTo

Relationships to other compositions/documents

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	DocumentRelationshipTypeCode replaces | transforms | signs | appends
target	Target

Target

Target of the relationship

Fields
Union field target. target can be only one of the following:
identifier	Identifier
reference	Reference

Section

Composition is broken into sections

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
title	String Label for section (e.g. for ToC)
code	CodeableConcept Classification of section (recommended)
text	Narrative Text summary of the section, for human interpretation
mode	ListModeCode working | snapshot | changes
ordered_by	CodeableConcept Order of section entries
entry[]	Reference A reference to data that supports this section
empty_reason	CodeableConcept Why the section is empty
section[]	Section Nested Section

CompositionAttestationModeCode

The way in which a person authenticated a composition. See http://hl7.org/fhir/ValueSet/composition-attestation-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PERSONAL
PROFESSIONAL
LEGAL
OFFICIAL

CompositionStatusCode

The workflow/clinical status of the composition. See http://hl7.org/fhir/ValueSet/composition-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PRELIMINARY
FINAL
AMENDED
ENTERED_IN_ERROR

ConceptMap

Auto-generated from StructureDefinition for ConceptMap, last updated 2017-04-19T07:44:43.294+10:00. A map from one set of concepts to one or more other concepts. See http://hl7.org/fhir/StructureDefinition/ConceptMap

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this concept map (globally unique)
identifier	Identifier Additional identifier for the concept map
version	String Business version of the concept map
name	String Name for this concept map (computer friendly)
title	String Name for this concept map (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the concept map
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for concept map (if applicable)
purpose	Markdown Why this concept map is defined
copyright	Markdown Use and/or publishing restrictions
source	Source
target	Target
group[]	Group

Group

Same source and target systems

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
source	Uri Code System (if value set crosses code systems)
source_version	String Specific version of the code system
target	Uri System of the target (if necessary)
target_version	String Specific version of the code system
element[]	SourceElement
unmapped	Unmapped

SourceElement

Mappings for a concept from the source set

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	Code Identifies element being mapped
display	String Display for the code
target[]	TargetElement

TargetElement

Concept in target system for element

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	Code Code that identifies the target element
display	String Display for the code
equivalence	ConceptMapEquivalenceCode relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
comment	String Description of status/issues in mapping
depends_on[]	OtherElement
product[]	OtherElement Other concepts that this mapping also produces

OtherElement

Other elements required for this mapping (from context)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
property	Uri Reference to property mapping depends on
system	Uri Code System (if necessary)
code	String Value of the referenced element
display	String Display for the code

Unmapped

When no match in the mappings

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
mode	ConceptMapGroupUnmappedModeCode provided | fixed | other-map
code	Code Fixed code when mode = fixed
display	String Display for the code
url	Uri Canonical URL for other concept map

Source

Identifies the source of the concepts which are being mapped

Fields
Union field source. source can be only one of the following:
uri	Uri
reference	Reference

Target

Provides context to the mappings

Fields
Union field target. target can be only one of the following:
uri	Uri
reference	Reference

ConceptMapEquivalenceCode

The degree of equivalence between concepts. See http://hl7.org/fhir/ValueSet/concept-map-equivalence

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
RELATEDTO
EQUIVALENT
EQUAL
WIDER
SUBSUMES
NARROWER
SPECIALIZES
INEXACT
UNMATCHED
DISJOINT

ConceptMapGroupUnmappedModeCode

Defines which action to take if there is no match in the group. See http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PROVIDED
FIXED
OTHER_MAP

Condition

Auto-generated from StructureDefinition for Condition, last updated 2017-04-19T07:44:43.294+10:00. Detailed information about conditions, problems or diagnoses. See http://hl7.org/fhir/StructureDefinition/Condition

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Ids for this condition
clinical_status	ConditionClinicalStatusCodesCode active | recurrence | inactive | remission | resolved
verification_status	ConditionVerificationStatusCode provisional | differential | confirmed | refuted | entered-in-error | unknown
category[]	CodeableConcept problem-list-item | encounter-diagnosis
severity	CodeableConcept Subjective severity of condition
code	CodeableConcept Identification of the condition, problem or diagnosis
body_site[]	CodeableConcept Anatomical location, if relevant
subject	Reference Who has the condition?
context	Reference Encounter or episode when condition first asserted
onset	Onset
abatement	Abatement
asserted_date	DateTime Date record was believed accurate
asserter	Reference Person who asserts this condition
stage	Stage
evidence[]	Evidence
note[]	Annotation Additional information about the Condition

Abatement

If/when in resolution/remission

Fields
Union field abatement. abatement can be only one of the following:
date_time	DateTime
age	Age
boolean	Boolean
period	Period
range	Range
string_value	String

Evidence

Supporting evidence

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code[]	CodeableConcept Manifestation/symptom
detail[]	Reference Supporting information found elsewhere

Onset

Estimated or actual date, date-time, or age

Fields
Union field onset. onset can be only one of the following:
date_time	DateTime
age	Age
period	Period
range	Range
string_value	String

Stage

Stage/grade, usually assessed formally

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
summary	CodeableConcept Simple summary (disease specific)
assessment[]	Reference Formal record of assessment

ConditionClinicalStatusCodesCode

Preferred value set for Condition Clinical Status. See http://hl7.org/fhir/ValueSet/condition-clinical

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
RECURRENCE
INACTIVE
REMISSION
RESOLVED

ConditionVerificationStatusCode

The verification status to support or decline the clinical status of the condition or diagnosis. See http://hl7.org/fhir/ValueSet/condition-ver-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PROVISIONAL
DIFFERENTIAL
CONFIRMED
REFUTED
ENTERED_IN_ERROR
UNKNOWN

ConditionalDeleteStatusCode

A code that indicates how the server supports conditional delete. See http://hl7.org/fhir/ValueSet/conditional-delete-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NOT_SUPPORTED
SINGLE
MULTIPLE

ConditionalReadStatusCode

A code that indicates how the server supports conditional read. See http://hl7.org/fhir/ValueSet/conditional-read-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NOT_SUPPORTED
MODIFIED_SINCE
NOT_MATCH
FULL_SUPPORT

ConfidentialityClassificationCode

Set of codes used to value Act.Confidentiality and Role.Confidentiality attribute in accordance with the definition for concept domain "Confidentiality". See http://hl7.org/fhir/ValueSet/v3-ConfidentialityClassification

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
U
L
M
N
R
V

Consent

Auto-generated from StructureDefinition for Consent, last updated 2017-04-19T07:44:43.294+10:00. A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time. See http://hl7.org/fhir/StructureDefinition/Consent

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Identifier for this record (external references)
status	ConsentStateCode draft | proposed | active | rejected | inactive | entered-in-error
category[]	CodeableConcept Classification of the consent statement - for indexing/retrieval
patient	Reference Who the consent applies to
period	Period Period that this consent applies
date_time	DateTime When this Consent was created or indexed
consenting_party[]	Reference Who is agreeing to the policy and exceptions
actor[]	Actor
action[]	CodeableConcept Actions controlled by this consent
organization[]	Reference Custodian of the consent
source	Source
policy[]	Policy
policy_rule	Uri Policy that this consents to
security_label[]	Coding Security Labels that define affected resources
purpose[]	Coding Context of activities for which the agreement is made
data_period	Period Timeframe for data controlled by this consent
data[]	Data
except[]	Except

Actor

Who|what controlled by this consent (or group, by role)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
role	CodeableConcept How the actor is involved
reference	Reference Resource for the actor (or group, by role)

Data

Data controlled by this consent

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
meaning	ConsentDataMeaningCode instance | related | dependents | authoredby
reference	Reference The actual data reference

Except

Additional rule - addition or removal of permissions

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	ConsentExceptTypeCode deny | permit
period	Period Timeframe for this exception
actor[]	ExceptActor
action[]	CodeableConcept Actions controlled by this exception
security_label[]	Coding Security Labels that define affected resources
purpose[]	Coding Context of activities covered by this exception
class_value[]	Coding e.g. Resource Type, Profile, or CDA etc
code[]	Coding e.g. LOINC or SNOMED CT code, etc in the content
data_period	Period Timeframe for data controlled by this exception
data[]	ExceptData

ExceptActor

Who|what controlled by this exception (or group, by role)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
role	CodeableConcept How the actor is involved
reference	Reference Resource for the actor (or group, by role)

ExceptData

Data controlled by this exception

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
meaning	ConsentDataMeaningCode instance | related | dependents | authoredby
reference	Reference The actual data reference

Policy

Policies covered by this consent

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
authority	Uri Enforcement source for policy
uri	Uri Specific policy covered by this consent

Source

Source from which this consent is taken

Fields
Union field source. source can be only one of the following:
attachment	Attachment
identifier	Identifier
reference	Reference

ConsentDataMeaningCode

How a resource reference is interpreted when testing consent restrictions See http://hl7.org/fhir/ValueSet/consent-data-meaning

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
INSTANCE
RELATED
DEPENDENTS
AUTHOREDBY

ConsentExceptTypeCode

How an exception statement is applied, such as adding additional consent or removing consent See http://hl7.org/fhir/ValueSet/consent-except-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DENY
PERMIT

ConsentStateCode

Indicates the state of the consent See http://hl7.org/fhir/ValueSet/consent-state-codes

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DRAFT
PROPOSED
ACTIVE
REJECTED
INACTIVE
ENTERED_IN_ERROR

ConstraintSeverityCode

SHALL applications comply with this constraint? See http://hl7.org/fhir/ValueSet/constraint-severity

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ERROR
WARNING

ContactDetail

Auto-generated from StructureDefinition for ContactDetail, last updated 2017-04-19T07:44:43.294+10:00. Contact information. See http://hl7.org/fhir/StructureDefinition/ContactDetail

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
name	String Name of an individual to contact
telecom[]	ContactPoint Contact details for individual or organization

ContactPoint

Auto-generated from StructureDefinition for ContactPoint, last updated 2017-04-19T07:44:43.294+10:00. Details of a Technology mediated contact point (phone, fax, email, etc.). See http://hl7.org/fhir/StructureDefinition/ContactPoint

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
system	ContactPointSystemCode phone | fax | email | pager | url | sms | other
value	String The actual contact point details
use	ContactPointUseCode home | work | temp | old | mobile - purpose of this contact point
rank	PositiveInt Specify preferred order of use (1 = highest)
period	Period Time period when the contact point was/is in use

ContactPointSystemCode

Telecommunications form for contact point See http://hl7.org/fhir/ValueSet/contact-point-system

Fields
value	Value
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
PHONE
FAX
EMAIL
PAGER
URL
SMS
OTHER

ContactPointUseCode

Use of contact point See http://hl7.org/fhir/ValueSet/contact-point-use

Fields
value	Value
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
HOME
WORK
TEMP
OLD
MOBILE

ContainedResource

Fields
Union field oneof_resource. oneof_resource can be only one of the following:
account	Account
activity_definition	ActivityDefinition
adverse_event	AdverseEvent
allergy_intolerance	AllergyIntolerance
appointment	Appointment
appointment_response	AppointmentResponse
audit_event	AuditEvent
basic	Basic
binary	Binary
body_site	BodySite
bundle	Bundle
capability_statement	CapabilityStatement
care_plan	CarePlan
care_team	CareTeam
charge_item	ChargeItem
claim	Claim
claim_response	ClaimResponse
clinical_impression	ClinicalImpression
code_system	CodeSystem
communication	Communication
communication_request	CommunicationRequest
compartment_definition	CompartmentDefinition
composition	Composition
concept_map	ConceptMap
condition	Condition
consent	Consent
contract	Contract
coverage	Coverage
data_element	DataElement
detected_issue	DetectedIssue
device	Device
device_component	DeviceComponent
device_metric	DeviceMetric
device_request	DeviceRequest
device_use_statement	DeviceUseStatement
diagnostic_report	DiagnosticReport
document_manifest	DocumentManifest
document_reference	DocumentReference
eligibility_request	EligibilityRequest
eligibility_response	EligibilityResponse
encounter	Encounter
endpoint	Endpoint
enrollment_request	EnrollmentRequest
enrollment_response	EnrollmentResponse
episode_of_care	EpisodeOfCare
expansion_profile	ExpansionProfile
explanation_of_benefit	ExplanationOfBenefit
family_member_history	FamilyMemberHistory
flag	Flag
goal	Goal
graph_definition	GraphDefinition
group	Group
guidance_response	GuidanceResponse
healthcare_service	HealthcareService
imaging_manifest	ImagingManifest
imaging_study	ImagingStudy
immunization	Immunization
immunization_recommendation	ImmunizationRecommendation
implementation_guide	ImplementationGuide
library	Library
linkage	Linkage
list	List
location	Location
measure	Measure
measure_report	MeasureReport
media	Media
medication	Medication
medication_administration	MedicationAdministration
medication_dispense	MedicationDispense
medication_request	MedicationRequest
medication_statement	MedicationStatement
message_definition	MessageDefinition
message_header	MessageHeader
naming_system	NamingSystem
nutrition_order	NutritionOrder
observation	Observation
operation_definition	OperationDefinition
operation_outcome	OperationOutcome
organization	Organization
parameters	Parameters
patient	Patient
payment_notice	PaymentNotice
payment_reconciliation	PaymentReconciliation
person	Person
plan_definition	PlanDefinition
practitioner	Practitioner
practitioner_role	PractitionerRole
procedure	Procedure
procedure_request	ProcedureRequest
process_request	ProcessRequest
process_response	ProcessResponse
provenance	Provenance
questionnaire	Questionnaire
questionnaire_response	QuestionnaireResponse
referral_request	ReferralRequest
related_person	RelatedPerson
request_group	RequestGroup
research_study	ResearchStudy
research_subject	ResearchSubject
risk_assessment	RiskAssessment
schedule	Schedule
search_parameter	SearchParameter
sequence	Sequence
service_definition	ServiceDefinition
slot	Slot
specimen	Specimen
structure_definition	StructureDefinition
structure_map	StructureMap
subscription	Subscription
substance	Substance
supply_delivery	SupplyDelivery
supply_request	SupplyRequest
task	Task
test_report	TestReport
test_script	TestScript
value_set	ValueSet
vision_prescription	VisionPrescription

ContentTypeCode

The content or mime type. See http://hl7.org/fhir/ValueSet/content-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
XML
JSON
TTL
NONE

Contract

Auto-generated from StructureDefinition for Contract, last updated 2017-04-19T07:44:43.294+10:00. Legal Agreement. See http://hl7.org/fhir/StructureDefinition/Contract

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Contract number
status	ContractResourceStatusCode amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
issued	DateTime When this Contract was issued
applies	Period Effective time
subject[]	Reference Contract Target Entity
topic[]	Reference Context of the Contract
authority[]	Reference Authority under which this Contract has standing
domain[]	Reference Domain in which this Contract applies
type	CodeableConcept Type or form
sub_type[]	CodeableConcept Subtype within the context of type
action[]	CodeableConcept Action stipulated by this Contract
action_reason[]	CodeableConcept Rationale for the stiplulated action
decision_type	CodeableConcept Decision by Grantor
content_derivative	CodeableConcept Content derived from the basal information
security_label[]	Coding Security Labels that define affected resources
agent[]	Agent
signer[]	Signatory
valued_item[]	ValuedItem
term[]	Term
binding	Binding
friendly[]	FriendlyLanguage
legal[]	LegalLanguage
rule[]	ComputableLanguage

Agent

Entity being ascribed responsibility

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
actor	Reference Contract Agent Type
role[]	CodeableConcept Role type of the agent

Binding

Binding Contract

Fields
Union field binding. binding can be only one of the following:
attachment	Attachment
reference	Reference

ComputableLanguage

Computable Contract Language

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
content	Content

Content

Computable Contract Rules

Fields
Union field content. content can be only one of the following:
attachment	Attachment
reference	Reference

FriendlyLanguage

Contract Friendly Language

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
content	Content

Content

Easily comprehended representation of this Contract

Fields
Union field content. content can be only one of the following:
attachment	Attachment
reference	Reference

LegalLanguage

Contract Legal Language

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
content	Content

Content

Contract Legal Text

Fields
Union field content. content can be only one of the following:
attachment	Attachment
reference	Reference

Signatory

Contract Signatory

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	Coding Contract Signatory Role
party	Reference Contract Signatory Party
signature[]	Signature Contract Documentation Signature

Term

Contract Term List

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Contract Term Number
issued	DateTime Contract Term Issue Date Time
applies	Period Contract Term Effective Time
type	CodeableConcept Contract Term Type or Form
sub_type	CodeableConcept Contract Term Type specific classification
topic[]	Reference Context of the Contract term
action[]	CodeableConcept Contract Term Activity
action_reason[]	CodeableConcept Purpose for the Contract Term Action
security_label[]	Coding Security Labels that define affected terms
agent[]	TermAgent
text	String Human readable Contract term text
valued_item[]	TermValuedItem
group[]	Term Nested Contract Term Group

TermAgent

Contract Term Agent List

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
actor	Reference Contract Term Agent Subject
role[]	CodeableConcept Type of the Contract Term Agent

TermValuedItem

Contract Term Valued Item List

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
entity	Entity
identifier	Identifier Contract Term Valued Item Number
effective_time	DateTime Contract Term Valued Item Effective Tiem
quantity	SimpleQuantity Contract Term Valued Item Count
unit_price	Money Contract Term Valued Item fee, charge, or cost
factor	Decimal Contract Term Valued Item Price Scaling Factor
points	Decimal Contract Term Valued Item Difficulty Scaling Factor
net	Money Total Contract Term Valued Item Value

Entity

Contract Term Valued Item Type

Fields
Union field entity. entity can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

ValuedItem

Contract Valued Item List

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
entity	Entity
identifier	Identifier Contract Valued Item Number
effective_time	DateTime Contract Valued Item Effective Tiem
quantity	SimpleQuantity Count of Contract Valued Items
unit_price	Money Contract Valued Item fee, charge, or cost
factor	Decimal Contract Valued Item Price Scaling Factor
points	Decimal Contract Valued Item Difficulty Scaling Factor
net	Money Total Contract Valued Item Value

Entity

Contract Valued Item Type

Fields
Union field entity. entity can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

ContractResourceStatusCode

This value set contract specific codes for status. See http://hl7.org/fhir/ValueSet/contract-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
AMENDED
APPENDED
CANCELLED
DISPUTED
ENTERED_IN_ERROR
EXECUTABLE
EXECUTED
NEGOTIABLE
OFFERED
POLICY
REJECTED
RENEWED
REVOKED
RESOLVED
TERMINATED

Contributor

Auto-generated from StructureDefinition for Contributor, last updated 2017-04-19T07:44:43.294+10:00. Contributor information. See http://hl7.org/fhir/StructureDefinition/Contributor

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
type	ContributorTypeCode author | editor | reviewer | endorser
name	String Who contributed the content
contact[]	ContactDetail Contact details of the contributor

ContributorTypeCode

The type of contributor See http://hl7.org/fhir/ValueSet/contributor-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
AUTHOR
EDITOR
REVIEWER
ENDORSER

Count

Auto-generated from StructureDefinition for Count, last updated 2017-04-19T07:44:43.294+10:00. A measured or measurable amount. See http://hl7.org/fhir/StructureDefinition/Count

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
value	Decimal Numerical value (with implicit precision)
comparator	QuantityComparatorCode < | <= | >= | > - how to understand the value
unit	String Unit representation
system	Uri System that defines coded unit form
code	Code Coded form of the unit

Coverage

Auto-generated from StructureDefinition for Coverage, last updated 2017-04-19T07:44:43.294+10:00. Insurance or medical plan or a payment agreement. See http://hl7.org/fhir/StructureDefinition/Coverage

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier The primary coverage ID
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
type	CodeableConcept Type of coverage such as medical or accident
policy_holder	Reference Owner of the policy
subscriber	Reference Subscriber to the policy
subscriber_id	String ID assigned to the Subscriber
beneficiary	Reference Plan Beneficiary
relationship	CodeableConcept Beneficiary relationship to the Subscriber
period	Period Coverage start and end dates
payor[]	Reference Identifier for the plan or agreement issuer
grouping	Group
dependent	String Dependent number
sequence	String The plan instance or sequence counter
order	PositiveInt Relative order of the coverage
network	String Insurer network
contract[]	Reference Contract details

Group

Additional coverage classifications

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
group	String An identifier for the group
group_display	String Display text for an identifier for the group
sub_group	String An identifier for the subsection of the group
sub_group_display	String Display text for the subsection of the group
plan	String An identifier for the plan
plan_display	String Display text for the plan
sub_plan	String An identifier for the subsection of the plan
sub_plan_display	String Display text for the subsection of the plan
class_value	String An identifier for the class
class_display	String Display text for the class
sub_class	String An identifier for the subsection of the class
sub_class_display	String Display text for the subsection of the subclass

DataElement

Auto-generated from StructureDefinition for DataElement, last updated 2017-04-19T07:44:43.294+10:00. Resource data element. See http://hl7.org/fhir/StructureDefinition/DataElement

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this data element (globally unique)
identifier[]	Identifier Additional identifier for the data element
version	String Business version of the data element
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
name	String Name for this data element (computer friendly)
title	String Name for this data element (human friendly)
contact[]	ContactDetail Contact details for the publisher
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for data element (if applicable)
copyright	Markdown Use and/or publishing restrictions
stringency	DataElementStringencyCode comparable | fully-specified | equivalent | convertable | scaleable | flexible
mapping[]	Mapping
element[]	ElementDefinition Definition of element

Mapping

External specification mapped to

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identity	Id Internal id when this mapping is used
uri	Uri Identifies what this mapping refers to
name	String Names what this mapping refers to
comment	String Versions, issues, scope limitations, etc.

DataElementStringencyCode

Indicates the degree of precision of the data element definition. See http://hl7.org/fhir/ValueSet/dataelement-stringency

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
COMPARABLE
FULLY_SPECIFIED
EQUIVALENT
CONVERTABLE
SCALEABLE
FLEXIBLE

DataRequirement

Auto-generated from StructureDefinition for DataRequirement, last updated 2017-04-19T07:44:43.294+10:00. Describes a required data item. See http://hl7.org/fhir/StructureDefinition/DataRequirement

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
type	FHIRAllTypesCode The type of the required data
profile[]	Uri The profile of the required data
must_support[]	String Indicates that specific structure elements are referenced by the knowledge module
code_filter[]	CodeFilter
date_filter[]	DateFilter

CodeFilter

What codes are expected

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
path	String The code-valued attribute of the filter
value_set	ValueSet
value_code[]	Code What code is expected
value_coding[]	Coding What Coding is expected
value_codeable_concept[]	CodeableConcept What CodeableConcept is expected

ValueSet

Valueset for the filter

Fields
Union field value_set. value_set can be only one of the following:
string_value	String
reference	Reference

DateFilter

What dates/date ranges are expected

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
path	String The date-valued attribute of the filter
value	Value

Value

The value of the filter, as a Period, DateTime, or Duration value

Fields
Union field value. value can be only one of the following:
date_time	DateTime
period	Period
duration	Duration

Date

Auto-generated from StructureDefinition for date, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type date. See http://hl7.org/fhir/StructureDefinition/date

Fields
value_us	int64 Primitive value for date
timezone	string
precision	Precision
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Precision

Enums
PRECISION_UNSPECIFIED
YEAR
MONTH
DAY

DateTime

Auto-generated from StructureDefinition for dateTime, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type dateTime. See http://hl7.org/fhir/StructureDefinition/dateTime

Fields
value_us	int64 Primitive value for dateTime
timezone	string
precision	Precision
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Precision

Enums
PRECISION_UNSPECIFIED
YEAR
MONTH
DAY
SECOND
MILLISECOND
MICROSECOND

DaysOfWeekCode

The days of the week. See http://hl7.org/fhir/ValueSet/days-of-week

Fields
value	Value
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
MON
TUE
WED
THU
FRI
SAT
SUN

Decimal

Auto-generated from StructureDefinition for decimal, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type decimal. See http://hl7.org/fhir/StructureDefinition/decimal

Fields
value	string Primitive value for decimal
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

DetectedIssue

Auto-generated from StructureDefinition for DetectedIssue, last updated 2017-04-19T07:44:43.294+10:00. Clinical issue with action. See http://hl7.org/fhir/StructureDefinition/DetectedIssue

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Unique id for the detected issue
status	ObservationStatusCode registered | preliminary | final | amended +
category	CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc.
severity	DetectedIssueSeverityCode high | moderate | low
patient	Reference Associated patient
date	DateTime When identified
author	Reference The provider or device that identified the issue
implicated[]	Reference Problem resource
detail	String Description and context
reference	Uri Authority for issue
mitigation[]	Mitigation

Mitigation

Step taken to address

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
action	CodeableConcept What mitigation?
date	DateTime Date committed
author	Reference Who is committing?

DetectedIssueSeverityCode

Indicates the potential degree of impact of the identified issue on the patient. See http://hl7.org/fhir/ValueSet/detectedissue-severity

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
HIGH
MODERATE
LOW

Device

Auto-generated from StructureDefinition for Device, last updated 2017-04-19T07:44:43.294+10:00. Item used in healthcare. See http://hl7.org/fhir/StructureDefinition/Device

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Instance identifier
udi	Udi
status	FHIRDeviceStatusCode active | inactive | entered-in-error | unknown
type	CodeableConcept What kind of device this is
lot_number	String Lot number of manufacture
manufacturer	String Name of device manufacturer
manufacture_date	DateTime Date when the device was made
expiration_date	DateTime Date and time of expiry of this device (if applicable)
model	String Model id assigned by the manufacturer
version	String Version number (i.e. software)
patient	Reference Patient to whom Device is affixed
owner	Reference Organization responsible for device
contact[]	ContactPoint Details for human/organization for support
location	Reference Where the resource is found
url	Uri Network address to contact device
note[]	Annotation Device notes and comments
safety[]	CodeableConcept Safety Characteristics of Device

Udi

Unique Device Identifier (UDI) Barcode string

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
device_identifier	String Mandatory fixed portion of UDI
name	String Device Name as appears on UDI label
jurisdiction	Uri Regional UDI authority
carrier_hrf	String UDI Human Readable Barcode String
carrier_aidc	Base64Binary UDI Machine Readable Barcode String
issuer	Uri UDI Issuing Organization
entry_type	UDIEntryTypeCode barcode | rfid | manual +

DeviceComponent

Auto-generated from StructureDefinition for DeviceComponent, last updated 2017-04-19T07:44:43.294+10:00. An instance of a medical-related component of a medical device. See http://hl7.org/fhir/StructureDefinition/DeviceComponent

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Instance id assigned by the software stack
type	CodeableConcept What kind of component it is
last_system_change	Instant Recent system change timestamp
source	Reference Top-level device resource link
parent	Reference Parent resource link
operational_status[]	CodeableConcept Current operational status of the component, for example On, Off or Standby
parameter_group	CodeableConcept Current supported parameter group
measurement_principle	MeasmntPrincipleCode other | chemical | electrical | impedance | nuclear | optical | thermal | biological | mechanical | acoustical | manual+
production_specification[]	ProductionSpecification
language_code	CodeableConcept Language code for the human-readable text strings produced by the device

ProductionSpecification

Specification details such as Component Revisions, or Serial Numbers

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
spec_type	CodeableConcept Type or kind of production specification, for example serial number or software revision
component_id	Identifier Internal component unique identification
production_spec	String A printable string defining the component

DeviceMetric

Auto-generated from StructureDefinition for DeviceMetric, last updated 2017-04-19T07:44:43.294+10:00. Measurement, calculation or setting capability of a medical device. See http://hl7.org/fhir/StructureDefinition/DeviceMetric

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Unique identifier of this DeviceMetric
type	CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting
unit	CodeableConcept Unit of Measure for the Metric
source	Reference Describes the link to the source Device
parent	Reference Describes the link to the parent DeviceComponent
operational_status	DeviceMetricOperationalStatusCode on | off | standby | entered-in-error
color	DeviceMetricColorCode black | red | green | yellow | blue | magenta | cyan | white
category	DeviceMetricCategoryCode measurement | setting | calculation | unspecified
measurement_period	Timing Describes the measurement repetition time
calibration[]	Calibration

Calibration

Describes the calibrations that have been performed or that are required to be performed

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	DeviceMetricCalibrationTypeCode unspecified | offset | gain | two-point
state	DeviceMetricCalibrationStateCode not-calibrated | calibration-required | calibrated | unspecified
time	Instant Describes the time last calibration has been performed

DeviceMetricCalibrationStateCode

Describes the state of a metric calibration. See http://hl7.org/fhir/ValueSet/metric-calibration-state

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NOT_CALIBRATED
CALIBRATION_REQUIRED
CALIBRATED
UNSPECIFIED

DeviceMetricCalibrationTypeCode

Describes the type of a metric calibration. See http://hl7.org/fhir/ValueSet/metric-calibration-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
UNSPECIFIED
OFFSET
GAIN
TWO_POINT

DeviceMetricCategoryCode

Describes the category of the metric. See http://hl7.org/fhir/ValueSet/metric-category

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
MEASUREMENT
SETTING
CALCULATION
UNSPECIFIED

DeviceMetricColorCode

Describes the typical color of representation. See http://hl7.org/fhir/ValueSet/metric-color

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
BLACK
RED
GREEN
YELLOW
BLUE
MAGENTA
CYAN
WHITE

DeviceMetricOperationalStatusCode

Describes the operational status of the DeviceMetric. See http://hl7.org/fhir/ValueSet/metric-operational-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ON
OFF
STANDBY
ENTERED_IN_ERROR

DeviceRequest

Auto-generated from StructureDefinition for DeviceRequest, last updated 2017-04-19T07:44:43.294+10:00. Medical device request. See http://hl7.org/fhir/StructureDefinition/DeviceRequest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Request identifier
definition[]	Reference Protocol or definition
based_on[]	Reference What request fulfills
prior_request[]	Reference What request replaces
group_identifier	Identifier Identifier of composite request
status	RequestStatusCode draft | active | suspended | completed | entered-in-error | cancelled
intent	CodeableConcept proposal | plan | original-order | encoded | reflex-order
priority	RequestPriorityCode Indicates how quickly the request should be addressed with respect to other requests
code	Code
subject	Reference Focus of request
context	Reference Encounter or Episode motivating request
occurrence	Occurrence
authored_on	DateTime When recorded
requester	Requester
performer_type	CodeableConcept Fille role
performer	Reference Requested Filler
reason_code[]	CodeableConcept Coded Reason for request
reason_reference[]	Reference Linked Reason for request
supporting_info[]	Reference Additional clinical information
note[]	Annotation Notes or comments
relevant_history[]	Reference Request provenance

Code

Device requested

Fields
Union field code. code can be only one of the following:
reference	Reference
codeable_concept	CodeableConcept

Occurrence

Desired time or schedule for use

Fields
Union field occurrence. occurrence can be only one of the following:
date_time	DateTime
period	Period
timing	Timing

Requester

Who/what is requesting diagnostics

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
agent	Reference Individual making the request
on_behalf_of	Reference Organization agent is acting for

DeviceUseStatement

Auto-generated from StructureDefinition for DeviceUseStatement, last updated 2017-04-19T07:44:43.294+10:00. Record of use of a device. See http://hl7.org/fhir/StructureDefinition/DeviceUseStatement

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External identifier for this record
status	DeviceUseStatementStatusCode active | completed | entered-in-error +
subject	Reference Patient using device
when_used	Period Period device was used
timing	TimingType
recorded_on	DateTime When statement was recorded
source	Reference Who made the statement
device	Reference Reference to device used
indication[]	CodeableConcept Why device was used
body_site	CodeableConcept Target body site
note[]	Annotation Addition details (comments, instructions)

TimingType

How often the device was used

Fields
Union field timing. timing can be only one of the following:
timing_value	Timing
period	Period
date_time	DateTime

DeviceUseStatementStatusCode

A coded concept indicating the current status of a the Device Usage See http://hl7.org/fhir/ValueSet/device-statement-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
COMPLETED
ENTERED_IN_ERROR
INTENDED
STOPPED
ON_HOLD

DiagnosticReport

Auto-generated from StructureDefinition for DiagnosticReport, last updated 2017-04-19T07:44:43.294+10:00. A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports. See http://hl7.org/fhir/StructureDefinition/DiagnosticReport

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business identifier for report
based_on[]	Reference What was requested
status	DiagnosticReportStatusCode registered | partial | preliminary | final +
category	CodeableConcept Service category
code	CodeableConcept Name/Code for this diagnostic report
subject	Reference The subject of the report - usually, but not always, the patient
context	Reference Health care event when test ordered
effective	Effective
issued	Instant DateTime this version was released
performer[]	Performer
specimen[]	Reference Specimens this report is based on
result[]	Reference Observations - simple, or complex nested groups
imaging_study[]	Reference Reference to full details of imaging associated with the diagnostic report
image[]	Image
conclusion	String Clinical Interpretation of test results
coded_diagnosis[]	CodeableConcept Codes for the conclusion
presented_form[]	Attachment Entire report as issued

Effective

Clinically relevant time/time-period for report

Fields
Union field effective. effective can be only one of the following:
date_time	DateTime
period	Period

Image

Key images associated with this report

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
comment	String Comment about the image (e.g. explanation)
link	Reference Reference to the image source

Performer

Participants in producing the report

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
role	CodeableConcept Type of performer
actor	Reference Practitioner or Organization participant

DiagnosticReportStatusCode

The status of the diagnostic report as a whole. See http://hl7.org/fhir/ValueSet/diagnostic-report-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
REGISTERED
PARTIAL
PRELIMINARY
FINAL
AMENDED
CORRECTED
APPENDED
CANCELLED
ENTERED_IN_ERROR
UNKNOWN

DigitalMediaTypeCode

Whether the media is a photo, video, or audio See http://hl7.org/fhir/ValueSet/digital-media-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PHOTO
VIDEO
AUDIO

DiscriminatorTypeCode

How an element value is interpreted when discrimination is evaluated See http://hl7.org/fhir/ValueSet/discriminator-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
VALUE
EXISTS
PATTERN
TYPE
PROFILE

Distance

Auto-generated from StructureDefinition for Distance, last updated 2017-04-19T07:44:43.294+10:00. A length - a value with a unit that is a physical distance. See http://hl7.org/fhir/StructureDefinition/Distance

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
value	Decimal Numerical value (with implicit precision)
comparator	QuantityComparatorCode < | <= | >= | > - how to understand the value
unit	String Unit representation
system	Uri System that defines coded unit form
code	Code Coded form of the unit

DocumentManifest

Auto-generated from StructureDefinition for DocumentManifest, last updated 2017-04-19T07:44:43.294+10:00. A list that defines a set of documents. See http://hl7.org/fhir/StructureDefinition/DocumentManifest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
master_identifier	Identifier Unique Identifier for the set of documents
identifier[]	Identifier Other identifiers for the manifest
status	DocumentReferenceStatusCode current | superseded | entered-in-error
type	CodeableConcept Kind of document set
subject	Reference The subject of the set of documents
created	DateTime When this document manifest created
author[]	Reference Who and/or what authored the manifest
recipient[]	Reference Intended to get notified about this set of documents
source	Uri The source system/application/software
description	String Human-readable description (title)
content[]	Content
related[]	Related

Content

The items included

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
p	P

P

Contents of this set of documents

Fields
Union field p. p can be only one of the following:
attachment	Attachment
reference	Reference

Related

Related things

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Identifiers of things that are related
ref	Reference Related Resource

DocumentModeCode

Whether the application produces or consumes documents. See http://hl7.org/fhir/ValueSet/document-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PRODUCER
CONSUMER

DocumentReference

Auto-generated from StructureDefinition for DocumentReference, last updated 2017-04-19T07:44:43.294+10:00. A reference to a document. See http://hl7.org/fhir/StructureDefinition/DocumentReference

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
master_identifier	Identifier Master Version Specific Identifier
identifier[]	Identifier Other identifiers for the document
status	DocumentReferenceStatusCode current | superseded | entered-in-error
doc_status	CompositionStatusCode preliminary | final | appended | amended | entered-in-error
type	CodeableConcept Kind of document (LOINC if possible)
class_value	CodeableConcept Categorization of document
subject	Reference Who/what is the subject of the document
created	DateTime Document creation time
indexed	Instant When this document reference was created
author[]	Reference Who and/or what authored the document
authenticator	Reference Who/what authenticated the document
custodian	Reference Organization which maintains the document
relates_to[]	RelatesTo
description	String Human-readable description (title)
security_label[]	CodeableConcept Document security-tags
content[]	Content
context	Context

Content

Document referenced

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
attachment	Attachment Where to access the document
format	Coding Format/content rules for the document

Context

Clinical context of document

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
encounter	Reference Context of the document content
event[]	CodeableConcept Main clinical acts documented
period	Period Time of service that is being documented
facility_type	CodeableConcept Kind of facility where patient was seen
practice_setting	CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
source_patient_info	Reference Patient demographics from source
related[]	Related

Related

Related identifiers or resources

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Identifier of related objects or events
ref	Reference Related Resource

RelatesTo

Relationships to other documents

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	DocumentRelationshipTypeCode replaces | transforms | signs | appends
target	Reference Target of the relationship

DocumentReferenceStatusCode

The status of the document reference. See http://hl7.org/fhir/ValueSet/document-reference-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CURRENT
SUPERSEDED
ENTERED_IN_ERROR

DocumentRelationshipTypeCode

The type of relationship between documents. See http://hl7.org/fhir/ValueSet/document-relationship-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
REPLACES
TRANSFORMS
SIGNS
APPENDS

Dosage

Auto-generated from StructureDefinition for Dosage, last updated 2017-04-19T07:44:43.294+10:00. How the medication is/was taken or should be taken. See http://hl7.org/fhir/StructureDefinition/Dosage

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
sequence	Integer The order of the dosage instructions
text	String Free text dosage instructions e.g. SIG
additional_instruction[]	CodeableConcept Supplemental instruction - e.g. "with meals"
patient_instruction	String Patient or consumer oriented instructions
timing	Timing When medication should be administered
as_needed	AsNeeded
site	CodeableConcept Body site to administer to
route	CodeableConcept How drug should enter body
method	CodeableConcept Technique for administering medication
dose	Dose
max_dose_per_period	Ratio Upper limit on medication per unit of time
max_dose_per_administration	SimpleQuantity Upper limit on medication per administration
max_dose_per_lifetime	SimpleQuantity Upper limit on medication per lifetime of the patient
rate	Rate

AsNeeded

Take "as needed" (for x)

Fields
Union field as_needed. as_needed can be only one of the following:
boolean	Boolean
codeable_concept	CodeableConcept

Dose

Amount of medication per dose

Fields
Union field dose. dose can be only one of the following:
range	Range
quantity	SimpleQuantity

Rate

Amount of medication per unit of time

Fields
Union field rate. rate can be only one of the following:
ratio	Ratio
range	Range
quantity	SimpleQuantity

Duration

Auto-generated from StructureDefinition for Duration, last updated 2017-04-19T07:44:43.294+10:00. A length of time. See http://hl7.org/fhir/StructureDefinition/Duration

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
value	Decimal Numerical value (with implicit precision)
comparator	QuantityComparatorCode < | <= | >= | > - how to understand the value
unit	String Unit representation
system	Uri System that defines coded unit form
code	Code Coded form of the unit

ElementDefinition

Auto-generated from StructureDefinition for ElementDefinition, last updated 2017-04-19T07:44:43.294+10:00. Definition of an element in a resource or extension. See http://hl7.org/fhir/StructureDefinition/ElementDefinition

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
path	String Path of the element in the hierarchy of elements
representation[]	PropertyRepresentationCode xmlAttr | xmlText | typeAttr | cdaText | xhtml
slice_name	String Name for this particular element (in a set of slices)
label	String Name for element to display with or prompt for element
code[]	Coding Corresponding codes in terminologies
slicing	Slicing
short	String Concise definition for space-constrained presentation
definition	Markdown Full formal definition as narrative text
comment	Markdown Comments about the use of this element
requirements	Markdown Why this resource has been created
alias[]	String Other names
min	UnsignedInt Minimum Cardinality
max	String Maximum Cardinality (a number or *)
base	Base
content_reference	Uri Reference to definition of content for the element
type[]	TypeRef
default_value	DefaultValue
meaning_when_missing	Markdown Implicit meaning when this element is missing
order_meaning	String What the order of the elements means
fixed	Fixed
pattern	Pattern
example[]	Example
min_value	MinValue
max_value	MaxValue
max_length	Integer Max length for strings
condition[]	Id Reference to invariant about presence
constraint[]	Constraint
must_support	Boolean If the element must supported
is_modifier	Boolean If this modifies the meaning of other elements
is_summary	Boolean Include when _summary = true?
binding	ElementDefinitionBinding
mapping[]	Mapping

Base

Base definition information for tools

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
path	String Path that identifies the base element
min	UnsignedInt Min cardinality of the base element
max	String Max cardinality of the base element

Constraint

Condition that must evaluate to true

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
key	Id Target of 'condition' reference above
requirements	String Why this constraint is necessary or appropriate
severity	ConstraintSeverityCode error | warning
human	String Human description of constraint
expression	String FHIRPath expression of constraint
xpath	String XPath expression of constraint
source	Uri Reference to original source of constraint

DefaultValue

Specified value if missing from instance

Fields
Union field default_value. default_value can be only one of the following:
base64_binary	Base64Binary
boolean	Boolean
code	Code
date	Date
date_time	DateTime
decimal	Decimal
id	Id
instant	Instant
integer	Integer
markdown	Markdown
oid	Oid
positive_int	PositiveInt
string_value	String
time	Time
unsigned_int	UnsignedInt
uri	Uri
address	Address
age	Age
annotation	Annotation
attachment	Attachment
codeable_concept	CodeableConcept
coding	Coding
contact_point	ContactPoint
count	Count
distance	Distance
duration	Duration
human_name	HumanName
identifier	Identifier
money	Money
period	Period
quantity	Quantity
range	Range
ratio	Ratio
reference	Reference
sampled_data	SampledData
signature	Signature
timing	Timing
meta	Meta

ElementDefinitionBinding

ValueSet details if this is coded

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
strength	BindingStrengthCode required | extensible | preferred | example
description	String Human explanation of the value set
value_set	ValueSet

ValueSet

Source of value set

Fields
Union field value_set. value_set can be only one of the following:
uri	Uri
reference	Reference

Example

Example value (as defined for type)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
label	String Describes the purpose of this example
value	Value

Value

Value of Example (one of allowed types)

Fields
Union field value. value can be only one of the following:
base64_binary	Base64Binary
boolean	Boolean
code	Code
date	Date
date_time	DateTime
decimal	Decimal
id	Id
instant	Instant
integer	Integer
markdown	Markdown
oid	Oid
positive_int	PositiveInt
string_value	String
time	Time
unsigned_int	UnsignedInt
uri	Uri
address	Address
age	Age
annotation	Annotation
attachment	Attachment
codeable_concept	CodeableConcept
coding	Coding
contact_point	ContactPoint
count	Count
distance	Distance
duration	Duration
human_name	HumanName
identifier	Identifier
money	Money
period	Period
quantity	Quantity
range	Range
ratio	Ratio
reference	Reference
sampled_data	SampledData
signature	Signature
timing	Timing
meta	Meta

Fixed

Value must be exactly this

Fields
Union field fixed. fixed can be only one of the following:
base64_binary	Base64Binary
boolean	Boolean
code	Code
date	Date
date_time	DateTime
decimal	Decimal
id	Id
instant	Instant
integer	Integer
markdown	Markdown
oid	Oid
positive_int	PositiveInt
string_value	String
time	Time
unsigned_int	UnsignedInt
uri	Uri
address	Address
age	Age
annotation	Annotation
attachment	Attachment
codeable_concept	CodeableConcept
coding	Coding
contact_point	ContactPoint
count	Count
distance	Distance
duration	Duration
human_name	HumanName
identifier	Identifier
money	Money
period	Period
quantity	Quantity
range	Range
ratio	Ratio
reference	Reference
sampled_data	SampledData
signature	Signature
timing	Timing
meta	Meta

Mapping

Map element to another set of definitions

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
identity	Id Reference to mapping declaration
language	MimeTypeCode Computable language of mapping
map	String Details of the mapping
comment	String Comments about the mapping or its use

MaxValue

Maximum Allowed Value (for some types)

Fields
Union field max_value. max_value can be only one of the following:
date	Date
date_time	DateTime
instant	Instant
time	Time
decimal	Decimal
integer	Integer
positive_int	PositiveInt
unsigned_int	UnsignedInt
quantity	Quantity

MinValue

Minimum Allowed Value (for some types)

Fields
Union field min_value. min_value can be only one of the following:
date	Date
date_time	DateTime
instant	Instant
time	Time
decimal	Decimal
integer	Integer
positive_int	PositiveInt
unsigned_int	UnsignedInt
quantity	Quantity

Pattern

Value must have at least these property values

Fields
Union field pattern. pattern can be only one of the following:
base64_binary	Base64Binary
boolean	Boolean
code	Code
date	Date
date_time	DateTime
decimal	Decimal
id	Id
instant	Instant
integer	Integer
markdown	Markdown
oid	Oid
positive_int	PositiveInt
string_value	String
time	Time
unsigned_int	UnsignedInt
uri	Uri
address	Address
age	Age
annotation	Annotation
attachment	Attachment
codeable_concept	CodeableConcept
coding	Coding
contact_point	ContactPoint
count	Count
distance	Distance
duration	Duration
human_name	HumanName
identifier	Identifier
money	Money
period	Period
quantity	Quantity
range	Range
ratio	Ratio
reference	Reference
sampled_data	SampledData
signature	Signature
timing	Timing
meta	Meta

Slicing

This element is sliced - slices follow

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
discriminator[]	Discriminator
description	String Text description of how slicing works (or not)
ordered	Boolean If elements must be in same order as slices
rules	SlicingRulesCode closed | open | openAtEnd

Discriminator

Element values that are used to distinguish the slices

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
type	DiscriminatorTypeCode value | exists | pattern | type | profile
path	String Path to element value

TypeRef

Data type and Profile for this element

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
code	Uri Data type or Resource (reference to definition)
profile	Uri Profile (StructureDefinition) to apply (or IG)
target_profile	Uri Profile (StructureDefinition) to apply to reference target (or IG)
aggregation[]	AggregationModeCode contained | referenced | bundled - how aggregated
versioning	ReferenceVersionRulesCode either | independent | specific

EligibilityRequest

Auto-generated from StructureDefinition for EligibilityRequest, last updated 2017-04-19T07:44:43.294+10:00. Determine insurance validity and scope of coverage. See http://hl7.org/fhir/StructureDefinition/EligibilityRequest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
priority	CodeableConcept Desired processing priority
patient	Reference The subject of the Products and Services
serviced	Serviced
created	DateTime Creation date
enterer	Reference Author
provider	Reference Responsible practitioner
organization	Reference Responsible organization
insurer	Reference Target
facility	Reference Servicing Facility
coverage	Reference Insurance or medical plan
business_arrangement	String Business agreement
benefit_category	CodeableConcept Type of services covered
benefit_sub_category	CodeableConcept Detailed services covered within the type

Serviced

Estimated date or dates of Service

Fields
Union field serviced. serviced can be only one of the following:
date	Date
period	Period

EligibilityResponse

Auto-generated from StructureDefinition for EligibilityResponse, last updated 2017-04-19T07:44:43.294+10:00. EligibilityResponse resource. See http://hl7.org/fhir/StructureDefinition/EligibilityResponse

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
created	DateTime Creation date
request_provider	Reference Responsible practitioner
request_organization	Reference Responsible organization
request	Reference Eligibility reference
outcome	CodeableConcept complete | error | partial
disposition	String Disposition Message
insurer	Reference Insurer issuing the coverage
inforce	Boolean Coverage inforce indicator
insurance[]	Insurance
form	CodeableConcept Printed Form Identifier
error[]	Errors

Errors

Processing errors

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	CodeableConcept Error code detailing processing issues

Insurance

Details by insurance coverage

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
coverage	Reference Updated Coverage details
contract	Reference Contract details
benefit_balance[]	Benefits

Benefits

Benefits by Category

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
category	CodeableConcept Type of services covered
sub_category	CodeableConcept Detailed services covered within the type
excluded	Boolean Excluded from the plan
name	String Short name for the benefit
description	String Description of the benefit or services covered
network	CodeableConcept In or out of network
unit	CodeableConcept Individual or family
term	CodeableConcept Annual or lifetime
financial[]	Benefit

Benefit

Benefit Summary

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept Deductable, visits, benefit amount
allowed	Allowed
used	Used

Allowed

Benefits allowed

Fields
Union field allowed. allowed can be only one of the following:
unsigned_int	UnsignedInt
string_value	String
money	Money

Used

Benefits used

Fields
Union field used. used can be only one of the following:
unsigned_int	UnsignedInt
money	Money

Encounter

Auto-generated from StructureDefinition for Encounter, last updated 2017-04-19T07:44:43.294+10:00. An interaction during which services are provided to the patient. See http://hl7.org/fhir/StructureDefinition/Encounter

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Identifier(s) by which this encounter is known
status	EncounterStatusCode planned | arrived | triaged | in-progress | onleave | finished | cancelled +
status_history[]	StatusHistory
class_value	Coding inpatient | outpatient | ambulatory | emergency +
class_history[]	ClassHistory
type[]	CodeableConcept Specific type of encounter
priority	CodeableConcept Indicates the urgency of the encounter
subject	Reference The patient ro group present at the encounter
episode_of_care[]	Reference Episode(s) of care that this encounter should be recorded against
incoming_referral[]	Reference The ReferralRequest that initiated this encounter
participant[]	Participant
appointment	Reference The appointment that scheduled this encounter
period	Period The start and end time of the encounter
length	Duration Quantity of time the encounter lasted (less time absent)
reason[]	CodeableConcept Reason the encounter takes place (code)
diagnosis[]	Diagnosis
account[]	Reference The set of accounts that may be used for billing for this Encounter
hospitalization	Hospitalization
location[]	Location
service_provider	Reference The custodian organization of this Encounter record
part_of	Reference Another Encounter this encounter is part of

ClassHistory

List of past encounter classes

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
class_value	Coding inpatient | outpatient | ambulatory | emergency +
period	Period The time that the episode was in the specified class

Diagnosis

The list of diagnosis relevant to this encounter

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
condition	Reference Reason the encounter takes place (resource)
role	CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
rank	PositiveInt Ranking of the diagnosis (for each role type)

Hospitalization

Details about the admission to a healthcare service

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
pre_admission_identifier	Identifier Pre-admission identifier
origin	Reference The location from which the patient came before admission
admit_source	CodeableConcept From where patient was admitted (physician referral, transfer)
re_admission	CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
diet_preference[]	CodeableConcept Diet preferences reported by the patient
special_courtesy[]	CodeableConcept Special courtesies (VIP, board member)
special_arrangement[]	CodeableConcept Wheelchair, translator, stretcher, etc.
destination	Reference Location to which the patient is discharged
discharge_disposition	CodeableConcept Category or kind of location after discharge

Location

List of locations where the patient has been

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
location	Reference Location the encounter takes place
status	EncounterLocationStatusCode planned | active | reserved | completed
period	Period Time period during which the patient was present at the location

Participant

List of participants involved in the encounter

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type[]	CodeableConcept Role of participant in encounter
period	Period Period of time during the encounter that the participant participated
individual	Reference Persons involved in the encounter other than the patient

StatusHistory

List of past encounter statuses

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
status	EncounterStatusCode planned | arrived | triaged | in-progress | onleave | finished | cancelled +
period	Period The time that the episode was in the specified status

EncounterLocationStatusCode

The status of the location. See http://hl7.org/fhir/ValueSet/encounter-location-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PLANNED
ACTIVE
RESERVED
COMPLETED

EncounterStatusCode

Current state of the encounter See http://hl7.org/fhir/ValueSet/encounter-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PLANNED
ARRIVED
TRIAGED
IN_PROGRESS
ONLEAVE
FINISHED
CANCELLED
ENTERED_IN_ERROR
UNKNOWN

Endpoint

Auto-generated from StructureDefinition for Endpoint, last updated 2017-04-19T07:44:43.294+10:00. The technical details of an endpoint that can be used for electronic services. See http://hl7.org/fhir/StructureDefinition/Endpoint

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Identifies this endpoint across multiple systems
status	EndpointStatusCode active | suspended | error | off | entered-in-error | test
connection_type	Coding Protocol/Profile/Standard to be used with this endpoint connection
name	String A name that this endpoint can be identified by
managing_organization	Reference Organization that manages this endpoint (may not be the organization that exposes the endpoint)
contact[]	ContactPoint Contact details for source (e.g. troubleshooting)
period	Period Interval the endpoint is expected to be operational
payload_type[]	CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
payload_mime_type[]	MimeTypeCode Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
address	Uri The technical base address for connecting to this endpoint
header[]	String Usage depends on the channel type

EndpointStatusCode

The status of the endpoint See http://hl7.org/fhir/ValueSet/endpoint-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
SUSPENDED
ERROR
OFF
ENTERED_IN_ERROR
TEST

EnrollmentRequest

Auto-generated from StructureDefinition for EnrollmentRequest, last updated 2017-04-19T07:44:43.294+10:00. Enrollment request. See http://hl7.org/fhir/StructureDefinition/EnrollmentRequest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
created	DateTime Creation date
insurer	Reference Target
provider	Reference Responsible practitioner
organization	Reference Responsible organization
subject	Reference The subject of the Products and Services
coverage	Reference Insurance information

EnrollmentResponse

Auto-generated from StructureDefinition for EnrollmentResponse, last updated 2017-04-19T07:44:43.294+10:00. EnrollmentResponse resource. See http://hl7.org/fhir/StructureDefinition/EnrollmentResponse

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
request	Reference Claim reference
outcome	CodeableConcept complete | error | partial
disposition	String Disposition Message
created	DateTime Creation date
organization	Reference Insurer
request_provider	Reference Responsible practitioner
request_organization	Reference Responsible organization

EpisodeOfCare

Auto-generated from StructureDefinition for EpisodeOfCare, last updated 2017-04-19T07:44:43.294+10:00. An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility. See http://hl7.org/fhir/StructureDefinition/EpisodeOfCare

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier(s) relevant for this EpisodeOfCare
status	EpisodeOfCareStatusCode planned | waitlist | active | onhold | finished | cancelled | entered-in-error
status_history[]	StatusHistory
type[]	CodeableConcept Type/class - e.g. specialist referral, disease management
diagnosis[]	Diagnosis
patient	Reference The patient who is the focus of this episode of care
managing_organization	Reference Organization that assumes care
period	Period Interval during responsibility is assumed
referral_request[]	Reference Originating Referral Request(s)
care_manager	Reference Care manager/care co-ordinator for the patient
team[]	Reference Other practitioners facilitating this episode of care
account[]	Reference The set of accounts that may be used for billing for this EpisodeOfCare

Diagnosis

The list of diagnosis relevant to this episode of care

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
condition	Reference Conditions/problems/diagnoses this episode of care is for
role	CodeableConcept Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)
rank	PositiveInt Ranking of the diagnosis (for each role type)

StatusHistory

Past list of status codes (the current status may be included to cover the start date of the status)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
status	EpisodeOfCareStatusCode planned | waitlist | active | onhold | finished | cancelled | entered-in-error
period	Period Duration the EpisodeOfCare was in the specified status

EpisodeOfCareStatusCode

The status of the episode of care. See http://hl7.org/fhir/ValueSet/episode-of-care-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PLANNED
WAITLIST
ACTIVE
ONHOLD
FINISHED
CANCELLED
ENTERED_IN_ERROR

EventCapabilityModeCode

The mode of a message capability statement. See http://hl7.org/fhir/ValueSet/event-capability-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
SENDER
RECEIVER

EventStatusCode

Codes identifying the stage lifecycle stage of a event See http://hl7.org/fhir/ValueSet/event-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PREPARATION
IN_PROGRESS
SUSPENDED
ABORTED
COMPLETED
ENTERED_IN_ERROR
UNKNOWN

EventTimingCode

Real world event relating to the schedule. See http://hl7.org/fhir/ValueSet/event-timing

Fields
value	Value
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
MORN
AFT
EVE
NIGHT
PHS
HS
WAKE
C
CM
CD
CV
AC
ACM
ACD
ACV
PC
PCM
PCD
PCV

ExpansionProfile

Auto-generated from StructureDefinition for ExpansionProfile, last updated 2017-04-19T07:44:43.294+10:00. Defines behaviour and contraints on the ValueSet Expansion operation. See http://hl7.org/fhir/StructureDefinition/ExpansionProfile

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this expansion profile (globally unique)
identifier	Identifier Additional identifier for the expansion profile
version	String Business version of the expansion profile
name	String Name for this expansion profile (computer friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the expansion profile
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for expansion profile (if applicable)
fixed_version[]	FixedVersion
excluded_system	ExcludedSystem
include_designations	Boolean Whether the expansion should include concept designations
designation	Designation
include_definition	Boolean Include or exclude the value set definition in the expansion
active_only	Boolean Include or exclude inactive concepts in the expansion
exclude_nested	Boolean Nested codes in the expansion or not
exclude_not_for_ui	Boolean Include or exclude codes which cannot be rendered in user interfaces in the value set expansion
exclude_post_coordinated	Boolean Include or exclude codes which are post coordinated expressions in the value set expansion
display_language	LanguageCode Specify the language for the display element of codes in the value set expansion
limited_expansion	Boolean Controls behaviour of the value set expand operation when value sets are too large to be completely expanded

Designation

When the expansion profile imposes designation contraints

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
include	DesignationInclude
exclude	DesignationExclude

DesignationExclude

Designations to be excluded

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
designation[]	DesignationExcludeDesignation

DesignationExcludeDesignation

The designation to be excluded

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
language	LanguageCode Human language of the designation to be excluded
use	Coding What kind of Designation to exclude

DesignationInclude

Designations to be included

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
designation[]	DesignationIncludeDesignation

DesignationIncludeDesignation

The designation to be included

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
language	LanguageCode Human language of the designation to be included
use	Coding What kind of Designation to include

ExcludedSystem

Systems/Versions to be exclude

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
system	Uri The specific code system to be excluded
version	String Specific version of the code system referred to

FixedVersion

Fix use of a code system to a particular version

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
system	Uri System to have its version fixed
version	String Specific version of the code system referred to
mode	SystemVersionProcessingModeCode default | check | override

ExplanationOfBenefit

Auto-generated from StructureDefinition for ExplanationOfBenefit, last updated 2017-04-19T07:44:43.294+10:00. Explanation of Benefit resource. See http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier
status	ExplanationOfBenefitStatusCode active | cancelled | draft | entered-in-error
type	CodeableConcept Type or discipline
sub_type[]	CodeableConcept Finer grained claim type information
patient	Reference The subject of the Products and Services
billable_period	Period Period for charge submission
created	DateTime Creation date
enterer	Reference Author
insurer	Reference Insurer responsible for the EOB
provider	Reference Responsible provider for the claim
organization	Reference Responsible organization for the claim
referral	Reference Treatment Referral
facility	Reference Servicing Facility
claim	Reference Claim reference
claim_response	Reference Claim response reference
outcome	CodeableConcept complete | error | partial
disposition	String Disposition Message
related[]	RelatedClaim
prescription	Reference Prescription authorizing services or products
original_prescription	Reference Original prescription if superceded by fulfiller
payee	Payee
information[]	SupportingInformation
care_team[]	CareTeam
diagnosis[]	Diagnosis
procedure[]	Procedure
precedence	PositiveInt Precedence (primary, secondary, etc.)
insurance	Insurance
accident	Accident
employment_impacted	Period Period unable to work
hospitalization	Period Period in hospital
item[]	Item
add_item[]	AddedItem
total_cost	Money Total Cost of service from the Claim
unalloc_deductable	Money Unallocated deductable
total_benefit	Money Total benefit payable for the Claim
payment	Payment
form	CodeableConcept Printed Form Identifier
process_note[]	Note
benefit_balance[]	BenefitBalance

Accident

Details of an accident

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
date	Date When the accident occurred
type	CodeableConcept The nature of the accident
location	Location

Location

Accident Place

Fields
Union field location. location can be only one of the following:
address	Address
reference	Reference

AddedItem

Insurer added line items

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence_link_id[]	PositiveInt Service instances
revenue	CodeableConcept Revenue or cost center code
category	CodeableConcept Type of service or product
service	CodeableConcept Billing Code
modifier[]	CodeableConcept Service/Product billing modifiers
fee	Money Professional fee or Product charge
note_number[]	PositiveInt List of note numbers which apply
adjudication[]	Adjudication Added items adjudication
detail[]	AddedItemsDetail

AddedItemsDetail

Added items details

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
revenue	CodeableConcept Revenue or cost center code
category	CodeableConcept Type of service or product
service	CodeableConcept Billing Code
modifier[]	CodeableConcept Service/Product billing modifiers
fee	Money Professional fee or Product charge
note_number[]	PositiveInt List of note numbers which apply
adjudication[]	Adjudication Added items detail adjudication

BenefitBalance

Balance by Benefit Category

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
category	CodeableConcept Type of services covered
sub_category	CodeableConcept Detailed services covered within the type
excluded	Boolean Excluded from the plan
name	String Short name for the benefit
description	String Description of the benefit or services covered
network	CodeableConcept In or out of network
unit	CodeableConcept Individual or family
term	CodeableConcept Annual or lifetime
financial[]	Benefit

Benefit

Benefit Summary

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept Deductable, visits, benefit amount
allowed	Allowed
used	Used

Allowed

Benefits allowed

Fields
Union field allowed. allowed can be only one of the following:
unsigned_int	UnsignedInt
string_value	String
money	Money

Used

Benefits used

Fields
Union field used. used can be only one of the following:
unsigned_int	UnsignedInt
money	Money

CareTeam

Care Team members

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Number to covey order of careteam
provider	Reference Member of the Care Team
responsible	Boolean Billing practitioner
role	CodeableConcept Role on the team
qualification	CodeableConcept Type, classification or Specialization

Diagnosis

List of Diagnosis

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Number to covey order of diagnosis
diagnosis	DiagnosisType
type[]	CodeableConcept Timing or nature of the diagnosis
package_code	CodeableConcept Package billing code

DiagnosisType

Patient's diagnosis

Fields
Union field diagnosis. diagnosis can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Insurance

Insurance or medical plan

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
coverage	Reference Insurance information
pre_auth_ref[]	String Pre-Authorization/Determination Reference

Item

Goods and Services

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Service instance
care_team_link_id[]	PositiveInt Applicable careteam members
diagnosis_link_id[]	PositiveInt Applicable diagnoses
procedure_link_id[]	PositiveInt Applicable procedures
information_link_id[]	PositiveInt Applicable exception and supporting information
revenue	CodeableConcept Revenue or cost center code
category	CodeableConcept Type of service or product
service	CodeableConcept Billing Code
modifier[]	CodeableConcept Service/Product billing modifiers
program_code[]	CodeableConcept Program specific reason for item inclusion
serviced	Serviced
location	Location
quantity	SimpleQuantity Count of Products or Services
unit_price	Money Fee, charge or cost per point
factor	Decimal Price scaling factor
net	Money Total item cost
udi[]	Reference Unique Device Identifier
body_site	CodeableConcept Service Location
sub_site[]	CodeableConcept Service Sub-location
encounter[]	Reference Encounters related to this billed item
note_number[]	PositiveInt List of note numbers which apply
adjudication[]	Adjudication
detail[]	Detail

Adjudication

Adjudication details

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
category	CodeableConcept Adjudication category such as co-pay, eligible, benefit, etc.
reason	CodeableConcept Explanation of Adjudication outcome
amount	Money Monetary amount
value	Decimal Non-monitory value

Detail

Additional items

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Service instance
type	CodeableConcept Group or type of product or service
revenue	CodeableConcept Revenue or cost center code
category	CodeableConcept Type of service or product
service	CodeableConcept Billing Code
modifier[]	CodeableConcept Service/Product billing modifiers
program_code[]	CodeableConcept Program specific reason for item inclusion
quantity	SimpleQuantity Count of Products or Services
unit_price	Money Fee, charge or cost per point
factor	Decimal Price scaling factor
net	Money Total additional item cost
udi[]	Reference Unique Device Identifier
note_number[]	PositiveInt List of note numbers which apply
adjudication[]	Adjudication Detail level adjudication details
sub_detail[]	SubDetail

SubDetail

Additional items

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Service instance
type	CodeableConcept Type of product or service
revenue	CodeableConcept Revenue or cost center code
category	CodeableConcept Type of service or product
service	CodeableConcept Billing Code
modifier[]	CodeableConcept Service/Product billing modifiers
program_code[]	CodeableConcept Program specific reason for item inclusion
quantity	SimpleQuantity Count of Products or Services
unit_price	Money Fee, charge or cost per point
factor	Decimal Price scaling factor
net	Money Net additional item cost
udi[]	Reference Unique Device Identifier
note_number[]	PositiveInt List of note numbers which apply
adjudication[]	Adjudication Language if different from the resource

Location

Place of service

Fields
Union field location. location can be only one of the following:
codeable_concept	CodeableConcept
address	Address
reference	Reference

Serviced

Date or dates of Service

Fields
Union field serviced. serviced can be only one of the following:
date	Date
period	Period

Note

Processing notes

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
number	PositiveInt Sequence number for this note
type	CodeableConcept display | print | printoper
text	String Note explanitory text
language	CodeableConcept Language if different from the resource

Payee

Party to be paid any benefits payable

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept Type of party: Subscriber, Provider, other
resource_type	CodeableConcept organization | patient | practitioner | relatedperson
party	Reference Party to receive the payable

Payment

Payment (if paid)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept Partial or Complete
adjustment	Money Payment adjustment for non-Claim issues
adjustment_reason	CodeableConcept Explanation for the non-claim adjustment
date	Date Expected date of Payment
amount	Money Payable amount after adjustment
identifier	Identifier Identifier of the payment instrument

Procedure

Procedures performed

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Procedure sequence for reference
date	DateTime When the procedure was performed
procedure	ProcedureType

ProcedureType

Patient's list of procedures performed

Fields
Union field procedure. procedure can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

RelatedClaim

Related Claims which may be revelant to processing this claim

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
claim	Reference Reference to the related claim
relationship	CodeableConcept How the reference claim is related
reference	Identifier Related file or case reference

SupportingInformation

Exceptions, special considerations, the condition, situation, prior or concurrent issues

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence	PositiveInt Information instance identifier
category	CodeableConcept General class of information
code	CodeableConcept Type of information
timing	TimingType
value	Value
reason	Coding Reason associated with the information

TimingType

When it occurred

Fields
Union field timing. timing can be only one of the following:
date	Date
period	Period

Value

Additional Data or supporting information

Fields
Union field value. value can be only one of the following:
string_value	String
quantity	Quantity
attachment	Attachment
reference	Reference

ExplanationOfBenefitStatusCode

A code specifying the state of the resource instance. See http://hl7.org/fhir/ValueSet/explanationofbenefit-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
CANCELLED
DRAFT
ENTERED_IN_ERROR

Extension

Optional Extensions Element See https://www.hl7.org/fhir/datatypes.html#Extension

Fields
id	String xml:id (or equivalent in JSON)
url	Uri identifies the meaning of the extension
value	ValueX
extension[]	Extension Additional Content defined by implementations

ValueX

Value of extension

Fields
Union field choice. choice can be only one of the following:
base64_binary	Base64Binary
boolean	Boolean
code	Code
date	Date
date_time	DateTime
decimal	Decimal
id	Id
instant	Instant
integer	Integer
markdown	Markdown
oid	Oid
positive_int	PositiveInt
string_value	String
time	Time
unsigned_int	UnsignedInt
uri	Uri
address	Address
age	Age
annotation	Annotation
attachment	Attachment
codeable_concept	CodeableConcept
coding	Coding
contact_point	ContactPoint
count	Count
distance	Distance
duration	Duration
human_name	HumanName
identifier	Identifier
money	Money
period	Period
quantity	Quantity
range	Range
ratio	Ratio
reference	Reference
sampled_data	SampledData
signature	Signature
timing	Timing
meta	Meta

ExtensionContextCode

How an extension context is interpreted. See http://hl7.org/fhir/ValueSet/extension-context

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
RESOURCE
DATATYPE
EXTENSION

FHIRAllTypesCode

Either an abstract type, a resource or a data type. See http://hl7.org/fhir/ValueSet/all-types

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ADDRESS
AGE
ANNOTATION
ATTACHMENT
BACKBONE_ELEMENT
CODEABLE_CONCEPT
CODING
CONTACT_DETAIL
CONTACT_POINT
CONTRIBUTOR
COUNT
DATA_REQUIREMENT
DISTANCE
DOSAGE
DURATION
ELEMENT
ELEMENT_DEFINITION
EXTENSION
HUMAN_NAME
IDENTIFIER
META
MONEY
NARRATIVE
PARAMETER_DEFINITION
PERIOD
QUANTITY
RANGE
RATIO
REFERENCE
RELATED_ARTIFACT
SAMPLED_DATA
SIGNATURE
SIMPLE_QUANTITY
TIMING
TRIGGER_DEFINITION
USAGE_CONTEXT
BASE64_BINARY
BOOLEAN
CODE
DATE
DATE_TIME
DECIMAL
ID
INSTANT
INTEGER
MARKDOWN
OID
POSITIVE_INT
STRING
TIME
UNSIGNED_INT
URI
UUID
XHTML
ACCOUNT
ACTIVITY_DEFINITION
ADVERSE_EVENT
ALLERGY_INTOLERANCE
APPOINTMENT
APPOINTMENT_RESPONSE
AUDIT_EVENT
BASIC
BINARY
BODY_SITE
BUNDLE
CAPABILITY_STATEMENT
CARE_PLAN
CARE_TEAM
CHARGE_ITEM
CLAIM
CLAIM_RESPONSE
CLINICAL_IMPRESSION
CODE_SYSTEM
COMMUNICATION
COMMUNICATION_REQUEST
COMPARTMENT_DEFINITION
COMPOSITION
CONCEPT_MAP
CONDITION
CONSENT
CONTRACT
COVERAGE
DATA_ELEMENT
DETECTED_ISSUE
DEVICE
DEVICE_COMPONENT
DEVICE_METRIC
DEVICE_REQUEST
DEVICE_USE_STATEMENT
DIAGNOSTIC_REPORT
DOCUMENT_MANIFEST
DOCUMENT_REFERENCE
DOMAIN_RESOURCE
ELIGIBILITY_REQUEST
ELIGIBILITY_RESPONSE
ENCOUNTER
ENDPOINT
ENROLLMENT_REQUEST
ENROLLMENT_RESPONSE
EPISODE_OF_CARE
EXPANSION_PROFILE
EXPLANATION_OF_BENEFIT
FAMILY_MEMBER_HISTORY
FLAG
GOAL
GRAPH_DEFINITION
GROUP
GUIDANCE_RESPONSE
HEALTHCARE_SERVICE
IMAGING_MANIFEST
IMAGING_STUDY
IMMUNIZATION
IMMUNIZATION_RECOMMENDATION
IMPLEMENTATION_GUIDE
LIBRARY
LINKAGE
LIST
LOCATION
MEASURE
MEASURE_REPORT
MEDIA
MEDICATION
MEDICATION_ADMINISTRATION
MEDICATION_DISPENSE
MEDICATION_REQUEST
MEDICATION_STATEMENT
MESSAGE_DEFINITION
MESSAGE_HEADER
NAMING_SYSTEM
NUTRITION_ORDER
OBSERVATION
OPERATION_DEFINITION
OPERATION_OUTCOME
ORGANIZATION
PARAMETERS
PATIENT
PAYMENT_NOTICE
PAYMENT_RECONCILIATION
PERSON
PLAN_DEFINITION
PRACTITIONER
PRACTITIONER_ROLE
PROCEDURE
PROCEDURE_REQUEST
PROCESS_REQUEST
PROCESS_RESPONSE
PROVENANCE
QUESTIONNAIRE
QUESTIONNAIRE_RESPONSE
REFERRAL_REQUEST
RELATED_PERSON
REQUEST_GROUP
RESEARCH_STUDY
RESEARCH_SUBJECT
RESOURCE
RISK_ASSESSMENT
SCHEDULE
SEARCH_PARAMETER
SEQUENCE
SERVICE_DEFINITION
SLOT
SPECIMEN
STRUCTURE_DEFINITION
STRUCTURE_MAP
SUBSCRIPTION
SUBSTANCE
SUPPLY_DELIVERY
SUPPLY_REQUEST
TASK
TEST_REPORT
TEST_SCRIPT
VALUE_SET
VISION_PRESCRIPTION
TYPE
ANY

FHIRDefinedTypeCode

Either a resource or a data type. See http://hl7.org/fhir/ValueSet/defined-types

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ADDRESS
AGE
ANNOTATION
ATTACHMENT
BACKBONE_ELEMENT
CODEABLE_CONCEPT
CODING
CONTACT_DETAIL
CONTACT_POINT
CONTRIBUTOR
COUNT
DATA_REQUIREMENT
DISTANCE
DOSAGE
DURATION
ELEMENT
ELEMENT_DEFINITION
EXTENSION
HUMAN_NAME
IDENTIFIER
META
MONEY
NARRATIVE
PARAMETER_DEFINITION
PERIOD
QUANTITY
RANGE
RATIO
REFERENCE
RELATED_ARTIFACT
SAMPLED_DATA
SIGNATURE
SIMPLE_QUANTITY
TIMING
TRIGGER_DEFINITION
USAGE_CONTEXT
BASE64_BINARY
BOOLEAN
CODE
DATE
DATE_TIME
DECIMAL
ID
INSTANT
INTEGER
MARKDOWN
OID
POSITIVE_INT
STRING
TIME
UNSIGNED_INT
URI
UUID
XHTML
ACCOUNT
ACTIVITY_DEFINITION
ADVERSE_EVENT
ALLERGY_INTOLERANCE
APPOINTMENT
APPOINTMENT_RESPONSE
AUDIT_EVENT
BASIC
BINARY
BODY_SITE
BUNDLE
CAPABILITY_STATEMENT
CARE_PLAN
CARE_TEAM
CHARGE_ITEM
CLAIM
CLAIM_RESPONSE
CLINICAL_IMPRESSION
CODE_SYSTEM
COMMUNICATION
COMMUNICATION_REQUEST
COMPARTMENT_DEFINITION
COMPOSITION
CONCEPT_MAP
CONDITION
CONSENT
CONTRACT
COVERAGE
DATA_ELEMENT
DETECTED_ISSUE
DEVICE
DEVICE_COMPONENT
DEVICE_METRIC
DEVICE_REQUEST
DEVICE_USE_STATEMENT
DIAGNOSTIC_REPORT
DOCUMENT_MANIFEST
DOCUMENT_REFERENCE
DOMAIN_RESOURCE
ELIGIBILITY_REQUEST
ELIGIBILITY_RESPONSE
ENCOUNTER
ENDPOINT
ENROLLMENT_REQUEST
ENROLLMENT_RESPONSE
EPISODE_OF_CARE
EXPANSION_PROFILE
EXPLANATION_OF_BENEFIT
FAMILY_MEMBER_HISTORY
FLAG
GOAL
GRAPH_DEFINITION
GROUP
GUIDANCE_RESPONSE
HEALTHCARE_SERVICE
IMAGING_MANIFEST
IMAGING_STUDY
IMMUNIZATION
IMMUNIZATION_RECOMMENDATION
IMPLEMENTATION_GUIDE
LIBRARY
LINKAGE
LIST
LOCATION
MEASURE
MEASURE_REPORT
MEDIA
MEDICATION
MEDICATION_ADMINISTRATION
MEDICATION_DISPENSE
MEDICATION_REQUEST
MEDICATION_STATEMENT
MESSAGE_DEFINITION
MESSAGE_HEADER
NAMING_SYSTEM
NUTRITION_ORDER
OBSERVATION
OPERATION_DEFINITION
OPERATION_OUTCOME
ORGANIZATION
PARAMETERS
PATIENT
PAYMENT_NOTICE
PAYMENT_RECONCILIATION
PERSON
PLAN_DEFINITION
PRACTITIONER
PRACTITIONER_ROLE
PROCEDURE
PROCEDURE_REQUEST
PROCESS_REQUEST
PROCESS_RESPONSE
PROVENANCE
QUESTIONNAIRE
QUESTIONNAIRE_RESPONSE
REFERRAL_REQUEST
RELATED_PERSON
REQUEST_GROUP
RESEARCH_STUDY
RESEARCH_SUBJECT
RESOURCE
RISK_ASSESSMENT
SCHEDULE
SEARCH_PARAMETER
SEQUENCE
SERVICE_DEFINITION
SLOT
SPECIMEN
STRUCTURE_DEFINITION
STRUCTURE_MAP
SUBSCRIPTION
SUBSTANCE
SUPPLY_DELIVERY
SUPPLY_REQUEST
TASK
TEST_REPORT
TEST_SCRIPT
VALUE_SET
VISION_PRESCRIPTION

FHIRDefinedTypeExtCode

Either a resource or a data type, extended to allow arbitrary other codes representing FHIR resources. See http://hl7.org/fhir/ValueSet/defined-types Due to https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=15559 there are two value sets with valueset url: http://hl7.org/fhir/ValueSet/defined-types. Fragment added here to disambiguate.

Fields
value	string
id	String
extension[]	Extension

FHIRDeviceStatusCode

The availability status of the device. See http://hl7.org/fhir/ValueSet/device-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
INACTIVE
ENTERED_IN_ERROR
UNKNOWN

FHIRSubstanceStatusCode

A code to indicate if the substance is actively used See http://hl7.org/fhir/ValueSet/substance-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
INACTIVE
ENTERED_IN_ERROR

FamilyHistoryStatusCode

A code that identifies the status of the family history record. See http://hl7.org/fhir/ValueSet/history-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PARTIAL
COMPLETED
ENTERED_IN_ERROR
HEALTH_UNKNOWN

FamilyMemberHistory

Auto-generated from StructureDefinition for FamilyMemberHistory, last updated 2017-04-19T07:44:43.294+10:00. Information about patient's relatives, relevant for patient. See http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Id(s) for this record
definition[]	Reference Instantiates protocol or definition
status	FamilyHistoryStatusCode partial | completed | entered-in-error | health-unknown
not_done	Boolean The taking of a family member's history did not occur
not_done_reason	CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred
patient	Reference Patient history is about
date	DateTime When history was captured/updated
name	String The family member described
relationship	CodeableConcept Relationship to the subject
gender	AdministrativeGenderCode male | female | other | unknown
born	Born
age	AgeType
estimated_age	Boolean Age is estimated?
deceased	Deceased
reason_code[]	CodeableConcept Why was family member history performed?
reason_reference[]	Reference Why was family member history performed?
note[]	Annotation General note about related person
condition[]	Condition

AgeType

(approximate) age

Fields
Union field age. age can be only one of the following:
age_value	Age
range	Range
string_value	String

Born

(approximate) date of birth

Fields
Union field born. born can be only one of the following:
period	Period
date	Date
string_value	String

Condition

Condition that the related person had

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	CodeableConcept Condition suffered by relation
outcome	CodeableConcept deceased | permanent disability | etc.
onset	Onset
note[]	Annotation Extra information about condition

Onset

When condition first manifested

Fields
Union field onset. onset can be only one of the following:
age	Age
range	Range
period	Period
string_value	String

Deceased

Dead? How old/when?

Fields
Union field deceased. deceased can be only one of the following:
boolean	Boolean
age	Age
range	Range
date	Date
string_value	String

FilterOperatorCode

The kind of operation to perform as a part of a property based filter. See http://hl7.org/fhir/ValueSet/filter-operator

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
EQUALS
IS_A
DESCENDENT_OF
IS_NOT_A
REGEX
IN
NOT_IN
GENERALIZES
EXISTS

FinancialResourceStatusCode

This value set includes Status codes. See http://hl7.org/fhir/ValueSet/fm-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
CANCELLED
DRAFT
ENTERED_IN_ERROR

Flag

Auto-generated from StructureDefinition for Flag, last updated 2017-04-19T07:44:43.294+10:00. Key information to flag to healthcare providers. See http://hl7.org/fhir/StructureDefinition/Flag

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business identifier
status	FlagStatusCode active | inactive | entered-in-error
category	CodeableConcept Clinical, administrative, etc.
code	CodeableConcept Coded or textual message to display to user
subject	Reference Who/What is flag about?
period	Period Time period when flag is active
encounter	Reference Alert relevant during encounter
author	Reference Flag creator

FlagStatusCode

Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or entered in error. See http://hl7.org/fhir/ValueSet/flag-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
INACTIVE
ENTERED_IN_ERROR

Goal

Auto-generated from StructureDefinition for Goal, last updated 2017-04-19T07:44:43.294+10:00. Describes the intended objective(s) for a patient, group or organization. See http://hl7.org/fhir/StructureDefinition/Goal

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Ids for this goal
status	GoalStatusCode proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
category[]	CodeableConcept E.g. Treatment, dietary, behavioral, etc.
priority	CodeableConcept high-priority | medium-priority | low-priority
description	CodeableConcept Code or text describing goal
subject	Reference Who this goal is intended for
start	Start
target	Target
status_date	Date When goal status took effect
status_reason	String Reason for current status
expressed_by	Reference Who's responsible for creating Goal?
addresses[]	Reference Issues addressed by this goal
note[]	Annotation Comments about the goal
outcome_code[]	CodeableConcept What result was achieved regarding the goal?
outcome_reference[]	Reference Observation that resulted from goal

Start

When goal pursuit begins

Fields
Union field start. start can be only one of the following:
date	Date
codeable_concept	CodeableConcept

Target

Target outcome for the goal

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
measure	CodeableConcept The parameter whose value is being tracked
detail	Detail
due	Due

Detail

The target value to be achieved

Fields
Union field detail. detail can be only one of the following:
quantity	Quantity
range	Range
codeable_concept	CodeableConcept

Due

Reach goal on or before

Fields
Union field due. due can be only one of the following:
date	Date
duration	Duration

GoalStatusCode

Indicates whether the goal has been met and is still being targeted See http://hl7.org/fhir/ValueSet/goal-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PROPOSED
ACCEPTED
PLANNED
IN_PROGRESS
ON_TARGET
AHEAD_OF_TARGET
BEHIND_TARGET
SUSTAINING
ACHIEVED
ON_HOLD
CANCELLED
ENTERED_IN_ERROR
REJECTED

GraphCompartmentRuleCode

How a compartment must be linked See http://hl7.org/fhir/ValueSet/graph-compartment-rule

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
IDENTICAL
MATCHING
DIFFERENT
CUSTOM

GraphDefinition

Auto-generated from StructureDefinition for GraphDefinition, last updated 2017-04-19T07:44:43.294+10:00. Definition of an graph of resources. See http://hl7.org/fhir/StructureDefinition/GraphDefinition

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this graph definition (globally unique)
version	String Business version of the graph definition
name	String Name for this graph definition (computer friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the graph definition
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for graph definition (if applicable)
purpose	Markdown Why this graph definition is defined
start	ResourceTypeCode Type of resource at which the graph starts
profile	Uri Profile on base resource
link[]	Link

Link

Links this graph makes rules about

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
path	String Path in the resource that contains the link
slice_name	String Which slice (if profiled)
min	Integer Minimum occurrences for this link
max	String Maximum occurrences for this link
description	String Why this link is specified
target[]	Target

Target

Potential target for the link

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	ResourceTypeCode Type of resource this link refers to
profile	Uri Profile for the target resource
compartment[]	Compartment
link[]	Link Additional links from target resource

Compartment

Compartment Consistency Rules

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	CompartmentTypeCode Identifies the compartment
rule	GraphCompartmentRuleCode identical | matching | different | custom
expression	String Custom rule, as a FHIRPath expression
description	String Documentation for FHIRPath expression

Group

Auto-generated from StructureDefinition for Group, last updated 2017-04-19T07:44:43.294+10:00. Group of multiple entities. See http://hl7.org/fhir/StructureDefinition/Group

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Unique id
active	Boolean Whether this group's record is in active use
type	GroupTypeCode person | animal | practitioner | device | medication | substance
actual	Boolean Descriptive or actual
code	CodeableConcept Kind of Group members
name	String Label for Group
quantity	UnsignedInt Number of members
characteristic[]	Characteristic
member[]	Member

Characteristic

Trait of group members

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	CodeableConcept Kind of characteristic
value	Value
exclude	Boolean Group includes or excludes
period	Period Period over which characteristic is tested

Value

Value held by characteristic

Fields
Union field value. value can be only one of the following:
codeable_concept	CodeableConcept
boolean	Boolean
quantity	Quantity
range	Range

Member

Who or what is in group

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
entity	Reference Reference to the group member
period	Period Period member belonged to the group
inactive	Boolean If member is no longer in group

GroupTypeCode

Types of resources that are part of group See http://hl7.org/fhir/ValueSet/group-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PERSON
ANIMAL
PRACTITIONER
DEVICE
MEDICATION
SUBSTANCE

GuidanceResponse

Auto-generated from StructureDefinition for GuidanceResponse, last updated 2017-04-19T07:44:43.294+10:00. The formal response to a guidance request. See http://hl7.org/fhir/StructureDefinition/GuidanceResponse

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
request_id	Id The id of the request associated with this response, if any
identifier	Identifier Business identifier
module	Reference A reference to a knowledge module
status	GuidanceResponseStatusCode success | data-requested | data-required | in-progress | failure | entered-in-error
subject	Reference Patient the request was performed for
context	Reference Encounter or Episode during which the response was returned
occurrence_date_time	DateTime When the guidance response was processed
performer	Reference Device returning the guidance
reason	Reason
note[]	Annotation Additional notes about the response
evaluation_message[]	Reference Messages resulting from the evaluation of the artifact or artifacts
output_parameters	Reference The output parameters of the evaluation, if any
result	Reference Proposed actions, if any
data_requirement[]	DataRequirement Additional required data

Reason

Reason for the response

Fields
Union field reason. reason can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

GuidanceResponseStatusCode

The status of a guidance response See http://hl7.org/fhir/ValueSet/guidance-response-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
SUCCESS
DATA_REQUESTED
DATA_REQUIRED
IN_PROGRESS
FAILURE
ENTERED_IN_ERROR

GuideDependencyTypeCode

How a dependency is represented when the guide is published. See http://hl7.org/fhir/ValueSet/guide-dependency-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
REFERENCE
INCLUSION

GuidePageKindCode

The kind of an included page. See http://hl7.org/fhir/ValueSet/guide-page-kind

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PAGE
EXAMPLE
LIST
INCLUDE
DIRECTORY
DICTIONARY
TOC
RESOURCE

HTTPVerbCode

HTTP verbs (in the HTTP command line). See http://hl7.org/fhir/ValueSet/http-verb

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
GET
POST
PUT
DELETE

HealthcareService

Auto-generated from StructureDefinition for HealthcareService, last updated 2017-04-19T07:44:43.294+10:00. The details of a healthcare service available at a location. See http://hl7.org/fhir/StructureDefinition/HealthcareService

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External identifiers for this item
active	Boolean Whether this healthcareservice is in active use
provided_by	Reference Organization that provides this service
category	CodeableConcept Broad category of service being performed or delivered
type[]	CodeableConcept Type of service that may be delivered or performed
specialty[]	CodeableConcept Specialties handled by the HealthcareService
location[]	Reference Location(s) where service may be provided
name	String Description of service as presented to a consumer while searching
comment	String Additional description and/or any specific issues not covered elsewhere
extra_details	String Extra details about the service that can't be placed in the other fields
photo	Attachment Facilitates quick identification of the service
telecom[]	ContactPoint Contacts related to the healthcare service
coverage_area[]	Reference Location(s) service is inteded for/available to
service_provision_code[]	CodeableConcept Conditions under which service is available/offered
eligibility	CodeableConcept Specific eligibility requirements required to use the service
eligibility_note	String Describes the eligibility conditions for the service
program_name[]	String Program Names that categorize the service
characteristic[]	CodeableConcept Collection of characteristics (attributes)
referral_method[]	CodeableConcept Ways that the service accepts referrals
appointment_required	Boolean If an appointment is required for access to this service
available_time[]	AvailableTime
not_available[]	NotAvailable
availability_exceptions	String Description of availability exceptions
endpoint[]	Reference Technical endpoints providing access to services operated for the location

AvailableTime

Times the Service Site is available

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
days_of_week[]	DaysOfWeekCode mon | tue | wed | thu | fri | sat | sun
all_day	Boolean Always available? e.g. 24 hour service
available_start_time	Time Opening time of day (ignored if allDay = true)
available_end_time	Time Closing time of day (ignored if allDay = true)

NotAvailable

Not available during this time due to provided reason

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
description	String Reason presented to the user explaining why time not available
during	Period Service not availablefrom this date

HumanName

Auto-generated from StructureDefinition for HumanName, last updated 2017-04-19T07:44:43.294+10:00. Name of a human - parts and usage. See http://hl7.org/fhir/StructureDefinition/HumanName

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
use	NameUseCode usual | official | temp | nickname | anonymous | old | maiden
text	String Text representation of the full name
family	String Family name (often called 'Surname')
given[]	String Given names (not always 'first'). Includes middle names
prefix[]	String Parts that come before the name
suffix[]	String Parts that come after the name
period	Period Time period when name was/is in use

Id

Auto-generated from StructureDefinition for id, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type id. See http://hl7.org/fhir/StructureDefinition/id

Fields
value	string Primitive value for id
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Identifier

Auto-generated from StructureDefinition for Identifier, last updated 2017-04-19T07:44:43.294+10:00. An identifier intended for computation. See http://hl7.org/fhir/StructureDefinition/Identifier

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
use	IdentifierUseCode usual | official | temp | secondary (If known)
type	CodeableConcept Description of identifier
system	Uri The namespace for the identifier value
value	String The value that is unique
period	Period Time period when id is/was valid for use
assigner	Reference Organization that issued id (may be just text)

IdentifierUseCode

Identifies the purpose for this identifier, if known . See http://hl7.org/fhir/ValueSet/identifier-use

Fields
value	Value
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
USUAL
OFFICIAL
TEMP
SECONDARY

IdentityAssuranceLevelCode

The level of confidence that this link represents the same actual person, based on NIST Authentication Levels. See http://hl7.org/fhir/ValueSet/identity-assuranceLevel

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
LEVEL1
LEVEL2
LEVEL3
LEVEL4

ImagingManifest

Auto-generated from StructureDefinition for ImagingManifest, last updated 2017-04-19T07:44:43.294+10:00. Key Object Selection. See http://hl7.org/fhir/StructureDefinition/ImagingManifest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier SOP Instance UID
patient	Reference Patient of the selected objects
authoring_time	DateTime Time when the selection of instances was made
author	Reference Author (human or machine)
description	String Description text
study[]	Study

Study

Study identity of the selected instances

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
uid	Oid Study instance UID
imaging_study	Reference Reference to ImagingStudy
endpoint[]	Reference Study access service endpoint
series[]	Series

Series

Series identity of the selected instances

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
uid	Oid Series instance UID
endpoint[]	Reference Series access endpoint
instance[]	Instance

Instance

The selected instance

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sop_class	Oid SOP class UID of instance
uid	Oid Selected instance UID

ImagingStudy

Auto-generated from StructureDefinition for ImagingStudy, last updated 2017-04-19T07:44:43.294+10:00. A set of images produced in single study (one or more series of references images). See http://hl7.org/fhir/StructureDefinition/ImagingStudy

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
uid	Oid Formal DICOM identifier for the study
accession	Identifier Related workflow identifier ("Accession Number")
identifier[]	Identifier Other identifiers for the study
availability	InstanceAvailabilityCode ONLINE | OFFLINE | NEARLINE | UNAVAILABLE
modality_list[]	Coding All series modality if actual acquisition modalities
patient	Reference Who the images are of
context	Reference Originating context
started	DateTime When the study was started
based_on[]	Reference Request fulfilled
referrer	Reference Referring physician
interpreter[]	Reference Who interpreted images
endpoint[]	Reference Study access endpoint
number_of_series	UnsignedInt Number of Study Related Series
number_of_instances	UnsignedInt Number of Study Related Instances
procedure_reference[]	Reference The performed Procedure reference
procedure_code[]	CodeableConcept The performed procedure code
reason	CodeableConcept Why the study was requested
description	String Institution-generated description
series[]	Series

Series

Each study has one or more series of instances

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
uid	Oid Formal DICOM identifier for this series
number	UnsignedInt Numeric identifier of this series
modality	Coding The modality of the instances in the series
description	String A short human readable summary of the series
number_of_instances	UnsignedInt Number of Series Related Instances
availability	InstanceAvailabilityCode ONLINE | OFFLINE | NEARLINE | UNAVAILABLE
endpoint[]	Reference Series access endpoint
body_site	Coding Body part examined
laterality	Coding Body part laterality
started	DateTime When the series started
performer[]	Reference Who performed the series
instance[]	Instance

Instance

A single SOP instance from the series

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
uid	Oid Formal DICOM identifier for this instance
number	UnsignedInt The number of this instance in the series
sop_class	Oid DICOM class type
title	String Description of instance

Immunization

Auto-generated from StructureDefinition for Immunization, last updated 2017-04-19T07:44:43.294+10:00. Immunization event information. See http://hl7.org/fhir/StructureDefinition/Immunization

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business identifier
status	ImmunizationStatusCodesCode completed | entered-in-error
not_given	Boolean Flag for whether immunization was given
vaccine_code	CodeableConcept Vaccine product administered
patient	Reference Who was immunized
encounter	Reference Encounter administered as part of
date	DateTime Vaccination administration date
primary_source	Boolean Indicates context the data was recorded in
report_origin	CodeableConcept Indicates the source of a secondarily reported record
location	Reference Where vaccination occurred
manufacturer	Reference Vaccine manufacturer
lot_number	String Vaccine lot number
expiration_date	Date Vaccine expiration date
site	CodeableConcept Body site vaccine was administered
route	CodeableConcept How vaccine entered body
dose_quantity	SimpleQuantity Amount of vaccine administered
practitioner[]	Practitioner
note[]	Annotation Vaccination notes
explanation	Explanation
reaction[]	Reaction
vaccination_protocol[]	VaccinationProtocol

Explanation

Administration/non-administration reasons

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
reason[]	CodeableConcept Why immunization occurred
reason_not_given[]	CodeableConcept Why immunization did not occur

Practitioner

Who performed event

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
role	CodeableConcept What type of performance was done
actor	Reference Individual who was performing

Reaction

Details of a reaction that follows immunization

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
date	DateTime When reaction started
detail	Reference Additional information on reaction
reported	Boolean Indicates self-reported reaction

VaccinationProtocol

What protocol was followed

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
dose_sequence	PositiveInt Dose number within series
description	String Details of vaccine protocol
authority	Reference Who is responsible for protocol
series	String Name of vaccine series
series_doses	PositiveInt Recommended number of doses for immunity
target_disease[]	CodeableConcept Disease immunized against
dose_status	CodeableConcept Indicates if dose counts towards immunity
dose_status_reason	CodeableConcept Why dose does (not) count

ImmunizationRecommendation

Auto-generated from StructureDefinition for ImmunizationRecommendation, last updated 2017-04-19T07:44:43.294+10:00. Guidance or advice relating to an immunization. See http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business identifier
patient	Reference Who this profile is for
recommendation[]	Recommendation

Recommendation

Vaccine administration recommendations

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
date	DateTime Date recommendation created
vaccine_code	CodeableConcept Vaccine recommendation applies to
target_disease	CodeableConcept Disease to be immunized against
dose_number	PositiveInt Recommended dose number
forecast_status	CodeableConcept Vaccine administration status
date_criterion[]	DateCriterion
protocol	Protocol
supporting_immunization[]	Reference Past immunizations supporting recommendation
supporting_patient_information[]	Reference Patient observations supporting recommendation

DateCriterion

Dates governing proposed immunization

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	CodeableConcept Type of date
value	DateTime Recommended date

Protocol

Protocol used by recommendation

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
dose_sequence	PositiveInt Dose number within sequence
description	String Protocol details
authority	Reference Who is responsible for protocol
series	String Name of vaccination series

ImmunizationStatusCodesCode

The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the current status of the administered dose of vaccine. See http://hl7.org/fhir/ValueSet/immunization-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
COMPLETED
ENTERED_IN_ERROR

ImplementationGuide

Auto-generated from StructureDefinition for ImplementationGuide, last updated 2017-04-19T07:44:43.294+10:00. A set of rules about how FHIR is used. See http://hl7.org/fhir/StructureDefinition/ImplementationGuide

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this implementation guide (globally unique)
version	String Business version of the implementation guide
name	String Name for this implementation guide (computer friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the implementation guide
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for implementation guide (if applicable)
copyright	Markdown Use and/or publishing restrictions
fhir_version	Id FHIR Version this Implementation Guide targets
dependency[]	Dependency
package_value[]	Package
global[]	Global
binary[]	Uri Image, css, script, etc.
page	Page

Dependency

Another Implementation guide this depends on

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	GuideDependencyTypeCode reference | inclusion
uri	Uri Where to find dependency

Global

Profiles that apply globally

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	ResourceTypeCode Type this profiles applies to
profile	Reference Profile that all resources must conform to

Package

Group of resources as used in .page.package

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Name used .page.package
description	String Human readable text describing the package
resource[]	Resource

Resource

Resource in the implementation guide

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
example	Boolean If not an example, has its normal meaning
name	String Human Name for the resource
description	String Reason why included in guide
acronym	String Short code to identify the resource
source	Source
example_for	Reference Resource this is an example of (if applicable)

Source

Location of the resource

Fields
Union field source. source can be only one of the following:
uri	Uri
reference	Reference

Page

Page/Section in the Guide

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
source	Uri Where to find that page
title	String Short title shown for navigational assistance
kind	GuidePageKindCode page | example | list | include | directory | dictionary | toc | resource
type[]	ResourceTypeCode Kind of resource to include in the list
package_value[]	String Name of package to include
format	MimeTypeCode Format of the page (e.g. html, markdown, etc.)
page[]	Page Nested Pages / Sections

InstanceAvailabilityCode

Availability of the resource See http://hl7.org/fhir/ValueSet/instance-availability

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ONLINE
OFFLINE
NEARLINE
UNAVAILABLE

Instant

Auto-generated from StructureDefinition for instant, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type instant. See http://hl7.org/fhir/StructureDefinition/instant

Fields
value_us	int64 Primitive value for instant
timezone	string
precision	Precision
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Precision

Enums
PRECISION_UNSPECIFIED
SECOND
MILLISECOND
MICROSECOND

Integer

Auto-generated from StructureDefinition for integer, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type integer. See http://hl7.org/fhir/StructureDefinition/integer

Fields
value	sint32 Primitive value for integer
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

IssueSeverityCode

How the issue affects the success of the action. See http://hl7.org/fhir/ValueSet/issue-severity

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
FATAL
ERROR
WARNING
INFORMATION

IssueTypeCode

A code that describes the type of issue. See http://hl7.org/fhir/ValueSet/issue-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
INVALID
STRUCTURE
REQUIRED
VALUE
INVARIANT
SECURITY
LOGIN
UNKNOWN
EXPIRED
FORBIDDEN
SUPPRESSED
PROCESSING
NOT_SUPPORTED
DUPLICATE
NOT_FOUND
TOO_LONG
CODE_INVALID
EXTENSION
TOO_COSTLY
BUSINESS_RULE
CONFLICT
INCOMPLETE
TRANSIENT
LOCK_ERROR
NO_STORE
EXCEPTION
TIMEOUT
THROTTLED
INFORMATIONAL

LanguageCode

This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47) See http://hl7.org/fhir/ValueSet/languages Note: For historical reasons, this does not use an enum to represent value.

Fields
value	string Primitive value for code
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Library

Auto-generated from StructureDefinition for Library, last updated 2017-04-19T07:44:43.294+10:00. Represents a library of quality improvement components. See http://hl7.org/fhir/StructureDefinition/Library

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this library (globally unique)
identifier[]	Identifier Additional identifier for the library
version	String Business version of the library
name	String Name for this library (computer friendly)
title	String Name for this library (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
type	CodeableConcept logic-library | model-definition | asset-collection | module-definition
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
description	Markdown Natural language description of the library
purpose	Markdown Why this library is defined
usage	String Describes the clinical usage of the library
approval_date	Date When the library was approved by publisher
last_review_date	Date When the library was last reviewed
effective_period	Period When the library is expected to be used
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for library (if applicable)
topic[]	CodeableConcept E.g. Education, Treatment, Assessment, etc
contributor[]	Contributor A content contributor
contact[]	ContactDetail Contact details for the publisher
copyright	Markdown Use and/or publishing restrictions
related_artifact[]	RelatedArtifact Additional documentation, citations, etc.
parameter[]	ParameterDefinition Parameters defined by the library
data_requirement[]	DataRequirement What data is referenced by this library
content[]	Attachment Contents of the library, either embedded or referenced

LinkTypeCode

The type of link between this patient resource and another patient resource. See http://hl7.org/fhir/ValueSet/link-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
REPLACED_BY
REPLACES
REFER
SEEALSO

Linkage

Auto-generated from StructureDefinition for Linkage, last updated 2017-04-19T07:44:43.294+10:00. Links records for 'same' item. See http://hl7.org/fhir/StructureDefinition/Linkage

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
active	Boolean Whether this linkage assertion is active or not
author	Reference Who is responsible for linkages
item[]	Item

Item

Item to be linked

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	LinkageTypeCode source | alternate | historical
resource	Reference Resource being linked

LinkageTypeCode

Used to distinguish different roles a resource can play within a set of linked resources See http://hl7.org/fhir/ValueSet/linkage-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
SOURCE
ALTERNATE
HISTORICAL

List

Auto-generated from StructureDefinition for List, last updated 2017-04-19T07:44:43.294+10:00. Information summarized from a list of other resources. See http://hl7.org/fhir/StructureDefinition/List

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business identifier
status	ListStatusCode current | retired | entered-in-error
mode	ListModeCode working | snapshot | changes
title	String Descriptive name for the list
code	CodeableConcept What the purpose of this list is
subject	Reference If all resources have the same subject
encounter	Reference Context in which list created
date	DateTime When the list was prepared
source	Reference Who and/or what defined the list contents (aka Author)
ordered_by	CodeableConcept What order the list has
note[]	Annotation Comments about the list
entry[]	Entry
empty_reason	CodeableConcept Why list is empty

Entry

Entries in the list

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
flag	CodeableConcept Status/Workflow information about this item
deleted	Boolean If this item is actually marked as deleted
date	DateTime When item added to list
item	Reference Actual entry

ListModeCode

The processing mode that applies to this list See http://hl7.org/fhir/ValueSet/list-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
WORKING
SNAPSHOT
CHANGES

ListStatusCode

The current state of the list See http://hl7.org/fhir/ValueSet/list-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CURRENT
RETIRED
ENTERED_IN_ERROR

Location

Auto-generated from StructureDefinition for Location, last updated 2017-04-19T07:44:43.294+10:00. Details and position information for a physical place. See http://hl7.org/fhir/StructureDefinition/Location

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Unique code or number identifying the location to its users
status	LocationStatusCode active | suspended | inactive
operational_status	Coding The Operational status of the location (typically only for a bed/room)
name	String Name of the location as used by humans
alias[]	String A list of alternate names that the location is known as, or was known as in the past
description	String Additional details about the location that could be displayed as further information to identify the location beyond its name
mode	LocationModeCode instance | kind
type	CodeableConcept Type of function performed
telecom[]	ContactPoint Contact details of the location
address	Address Physical location
physical_type	CodeableConcept Physical form of the location
position	Position
managing_organization	Reference Organization responsible for provisioning and upkeep
part_of	Reference Another Location this one is physically part of
endpoint[]	Reference Technical endpoints providing access to services operated for the location

Position

The absolute geographic location

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
longitude	Decimal Longitude with WGS84 datum
latitude	Decimal Latitude with WGS84 datum
altitude	Decimal Altitude with WGS84 datum

LocationModeCode

Indicates whether a resource instance represents a specific location or a class of locations. See http://hl7.org/fhir/ValueSet/location-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
INSTANCE
KIND

LocationStatusCode

Indicates whether the location is still in use. See http://hl7.org/fhir/ValueSet/location-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
SUSPENDED
INACTIVE

Markdown

Auto-generated from StructureDefinition for markdown, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type markdown. See http://hl7.org/fhir/StructureDefinition/markdown

Fields
value	string Primitive value for markdown
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

MeasmntPrincipleCode

Different measurement principle supported by the device. See http://hl7.org/fhir/ValueSet/measurement-principle

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
OTHER
CHEMICAL
ELECTRICAL
IMPEDANCE
NUCLEAR
OPTICAL
THERMAL
BIOLOGICAL
MECHANICAL
ACOUSTICAL
MANUAL

Measure

Auto-generated from StructureDefinition for Measure, last updated 2017-04-19T07:44:43.294+10:00. A quality measure definition. See http://hl7.org/fhir/StructureDefinition/Measure

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this measure (globally unique)
identifier[]	Identifier Additional identifier for the measure
version	String Business version of the measure
name	String Name for this measure (computer friendly)
title	String Name for this measure (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
description	Markdown Natural language description of the measure
purpose	Markdown Why this measure is defined
usage	String Describes the clinical usage of the measure
approval_date	Date When the measure was approved by publisher
last_review_date	Date When the measure was last reviewed
effective_period	Period When the measure is expected to be used
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for measure (if applicable)
topic[]	CodeableConcept E.g. Education, Treatment, Assessment, etc
contributor[]	Contributor A content contributor
contact[]	ContactDetail Contact details for the publisher
copyright	Markdown Use and/or publishing restrictions
related_artifact[]	RelatedArtifact Additional documentation, citations, etc
library[]	Reference Logic used by the measure
disclaimer	Markdown Disclaimer for use of the measure or its referenced content
scoring	CodeableConcept proportion | ratio | continuous-variable | cohort
composite_scoring	CodeableConcept opportunity | all-or-nothing | linear | weighted
type[]	CodeableConcept process | outcome | structure | patient-reported-outcome | composite
risk_adjustment	String How is risk adjustment applied for this measure
rate_aggregation	String How is rate aggregation performed for this measure
rationale	Markdown Why does this measure exist
clinical_recommendation_statement	Markdown Summary of clinical guidelines
improvement_notation	String Improvement notation for the measure, e.g. higher score indicates better quality
definition[]	Markdown Defined terms used in the measure documentation
guidance	Markdown Additional guidance for implementers
set	String The measure set, e.g. Preventive Care and Screening
group[]	Group
supplemental_data[]	SupplementalData

Group

Population criteria group

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Unique identifier
name	String Short name
description	String Summary description
population[]	Population
stratifier[]	Stratifier

Population

Population criteria

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Unique identifier
code	CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
name	String Short name
description	String The human readable description of this population criteria
criteria	String The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria

Stratifier

Stratifier criteria for the measure

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier The identifier for the stratifier used to coordinate the reported data back to this stratifier
criteria	String How the measure should be stratified
path	String Path to the stratifier

SupplementalData

What other data should be reported with the measure

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Identifier, unique within the measure
usage[]	CodeableConcept supplemental-data | risk-adjustment-factor
criteria	String Expression describing additional data to be reported
path	String Path to the supplemental data element

MeasureReport

Auto-generated from StructureDefinition for MeasureReport, last updated 2017-04-19T07:44:43.294+10:00. Results of a measure evaluation. See http://hl7.org/fhir/StructureDefinition/MeasureReport

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Additional identifier for the Report
status	MeasureReportStatusCode complete | pending | error
type	MeasureReportTypeCode individual | patient-list | summary
measure	Reference What measure was evaluated
patient	Reference What patient the report is for
date	DateTime When the report was generated
reporting_organization	Reference Who is reporting the data
period	Period What period the report covers
group[]	Group
evaluated_resources	Reference What data was evaluated to produce the measure score

Group

Measure results for each group

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier What group of the measure
population[]	Population
measure_score	Decimal What score this group achieved
stratifier[]	Stratifier

Population

The populations in the group

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Population identifier as defined in the measure
code	CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score
count	Integer Size of the population
patients	Reference For patient-list reports, the patients in this population

Stratifier

Stratification results

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier What stratifier of the group
stratum[]	StratifierGroup

StratifierGroup

Stratum results, one for each unique value in the stratifier

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
value	String The stratum value, e.g. male
population[]	StratifierGroupPopulation
measure_score	Decimal What score this stratum achieved

StratifierGroupPopulation

Population results in this stratum

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Population identifier as defined in the measure
code	CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score
count	Integer Size of the population
patients	Reference For patient-list reports, the patients in this population

MeasureReportStatusCode

The status of the measure report See http://hl7.org/fhir/ValueSet/measure-report-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
COMPLETE
PENDING
ERROR

MeasureReportTypeCode

The type of the measure report See http://hl7.org/fhir/ValueSet/measure-report-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
INDIVIDUAL
PATIENT_LIST
SUMMARY

Media

Auto-generated from StructureDefinition for Media, last updated 2017-04-19T07:44:43.294+10:00. A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. See http://hl7.org/fhir/StructureDefinition/Media

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Identifier(s) for the image
based_on[]	Reference Procedure that caused this media to be created
type	DigitalMediaTypeCode photo | video | audio
subtype	CodeableConcept The type of acquisition equipment/process
view	CodeableConcept Imaging view, e.g. Lateral or Antero-posterior
subject	Reference Who/What this Media is a record of
context	Reference Encounter / Episode associated with media
occurrence	Occurrence
operator	Reference The person who generated the image
reason_code[]	CodeableConcept Why was event performed?
body_site	CodeableConcept Body part in media
device	Reference Observing Device
height	PositiveInt Height of the image in pixels (photo/video)
width	PositiveInt Width of the image in pixels (photo/video)
frames	PositiveInt Number of frames if > 1 (photo)
duration	UnsignedInt Length in seconds (audio / video)
content	Attachment Actual Media - reference or data
note[]	Annotation Comments made about the media

Occurrence

When Media was collected

Fields
Union field occurrence. occurrence can be only one of the following:
date_time	DateTime
period	Period

Medication

Auto-generated from StructureDefinition for Medication, last updated 2017-04-19T07:44:43.294+10:00. Definition of a Medication. See http://hl7.org/fhir/StructureDefinition/Medication

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	CodeableConcept Codes that identify this medication
status	MedicationStatusCode active | inactive | entered-in-error
is_brand	Boolean True if a brand
is_over_the_counter	Boolean True if medication does not require a prescription
manufacturer	Reference Manufacturer of the item
form	CodeableConcept powder | tablets | capsule +
ingredient[]	Ingredient
package_value	Package
image[]	Attachment Picture of the medication

Ingredient

Active or inactive ingredient

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
item	Item
is_active	Boolean Active ingredient indicator
amount	Ratio Quantity of ingredient present

Item

The product contained

Fields
Union field item. item can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Package

Details about packaged medications

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
container	CodeableConcept E.g. box, vial, blister-pack
content[]	Content
batch[]	Batch

Batch

Identifies a single production run

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
lot_number	String Identifier assigned to batch
expiration_date	DateTime When batch will expire

Content

What is in the package

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
item	Item
amount	SimpleQuantity Quantity present in the package

Item

The item in the package

Fields
Union field item. item can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

MedicationAdministration

Auto-generated from StructureDefinition for MedicationAdministration, last updated 2017-04-19T07:44:43.294+10:00. Administration of medication to a patient. See http://hl7.org/fhir/StructureDefinition/MedicationAdministration

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External identifier
definition[]	Reference Instantiates protocol or definition
part_of[]	Reference Part of referenced event
status	MedicationAdministrationStatusCode in-progress | on-hold | completed | entered-in-error | stopped | unknown
category	CodeableConcept Type of medication usage
medication	Medication
subject	Reference Who received medication
context	Reference Encounter or Episode of Care administered as part of
supporting_information[]	Reference Additional information to support administration
effective	Effective
performer[]	Performer
not_given	Boolean True if medication not administered
reason_not_given[]	CodeableConcept Reason administration not performed
reason_code[]	CodeableConcept Reason administration performed
reason_reference[]	Reference Condition or Observation that supports why the medication was administered
prescription	Reference Request administration performed against
device[]	Reference Device used to administer
note[]	Annotation Information about the administration
dosage	Dosage
event_history[]	Reference A list of events of interest in the lifecycle

Dosage

Details of how medication was taken

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
text	String Free text dosage instructions e.g. SIG
site	CodeableConcept Body site administered to
route	CodeableConcept Path of substance into body
method	CodeableConcept How drug was administered
dose	SimpleQuantity Amount of medication per dose
rate	Rate

Rate

Dose quantity per unit of time

Fields
Union field rate. rate can be only one of the following:
ratio	Ratio
quantity	SimpleQuantity

Effective

Start and end time of administration

Fields
Union field effective. effective can be only one of the following:
date_time	DateTime
period	Period

Medication

What was administered

Fields
Union field medication. medication can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Performer

Who administered substance

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
actor	Reference Individual who was performing
on_behalf_of	Reference Organization organization was acting for

MedicationAdministrationStatusCode

A set of codes indicating the current status of a MedicationAdministration. See http://hl7.org/fhir/ValueSet/medication-admin-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
IN_PROGRESS
ON_HOLD
COMPLETED
ENTERED_IN_ERROR
STOPPED
UNKNOWN

MedicationDispense

Auto-generated from StructureDefinition for MedicationDispense, last updated 2017-04-19T07:44:43.294+10:00. Dispensing a medication to a named patient. See http://hl7.org/fhir/StructureDefinition/MedicationDispense

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External identifier
part_of[]	Reference Event that dispense is part of
status	MedicationDispenseStatusCode preparation | in-progress | on-hold | completed | entered-in-error | stopped
category	CodeableConcept Type of medication dispense
medication	Medication
subject	Reference Who the dispense is for
context	Reference Encounter / Episode associated with event
supporting_information[]	Reference Information that supports the dispensing of the medication
performer[]	Performer
authorizing_prescription[]	Reference Medication order that authorizes the dispense
type	CodeableConcept Trial fill, partial fill, emergency fill, etc.
quantity	SimpleQuantity Amount dispensed
days_supply	SimpleQuantity Amount of medication expressed as a timing amount
when_prepared	DateTime When product was packaged and reviewed
when_handed_over	DateTime When product was given out
destination	Reference Where the medication was sent
receiver[]	Reference Who collected the medication
note[]	Annotation Information about the dispense
dosage_instruction[]	Dosage How the medication is to be used by the patient or administered by the caregiver
substitution	Substitution
detected_issue[]	Reference Clinical issue with action
not_done	Boolean Whether the dispense was or was not performed
not_done_reason	NotDoneReason
event_history[]	Reference A list of releveant lifecycle events

Medication

What medication was supplied

Fields
Union field medication. medication can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

NotDoneReason

Why a dispense was not performed

Fields
Union field not_done_reason. not_done_reason can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Performer

Who performed event

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
actor	Reference Individual who was performing
on_behalf_of	Reference Organization organization was acting for

Substitution

Whether a substitution was performed on the dispense

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
was_substituted	Boolean Whether a substitution was or was not performed on the dispense
type	CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
reason[]	CodeableConcept Why was substitution made
responsible_party[]	Reference Who is responsible for the substitution

MedicationDispenseStatusCode

A coded concept specifying the state of the dispense event. See http://hl7.org/fhir/ValueSet/medication-dispense-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PREPARATION
IN_PROGRESS
ON_HOLD
COMPLETED
ENTERED_IN_ERROR
STOPPED

MedicationRequest

Auto-generated from StructureDefinition for MedicationRequest, last updated 2017-04-19T07:44:43.294+10:00. Ordering of medication for patient or group. See http://hl7.org/fhir/StructureDefinition/MedicationRequest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External ids for this request
definition[]	Reference Protocol or definition
based_on[]	Reference What request fulfills
group_identifier	Identifier Composite request this is part of
status	MedicationRequestStatusCode active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
intent	MedicationRequestIntentCode proposal | plan | order | instance-order
category	CodeableConcept Type of medication usage
priority	MedicationRequestPriorityCode routine | urgent | stat | asap
medication	Medication
subject	Reference Who or group medication request is for
context	Reference Created during encounter/admission/stay
supporting_information[]	Reference Information to support ordering of the medication
authored_on	DateTime When request was initially authored
requester	Requester
recorder	Reference Person who entered the request
reason_code[]	CodeableConcept Reason or indication for writing the prescription
reason_reference[]	Reference Condition or Observation that supports why the prescription is being written
note[]	Annotation Information about the prescription
dosage_instruction[]	Dosage How the medication should be taken
dispense_request	DispenseRequest
substitution	Substitution
prior_prescription	Reference An order/prescription that is being replaced
detected_issue[]	Reference Clinical Issue with action
event_history[]	Reference A list of events of interest in the lifecycle

DispenseRequest

Medication supply authorization

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
validity_period	Period Time period supply is authorized for
number_of_repeats_allowed	PositiveInt Number of refills authorized
quantity	SimpleQuantity Amount of medication to supply per dispense
expected_supply_duration	Duration Number of days supply per dispense
performer	Reference Intended dispenser

Medication

Medication to be taken

Fields
Union field medication. medication can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Requester

Who/What requested the Request

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
agent	Reference Who ordered the initial medication(s)
on_behalf_of	Reference Organization agent is acting for

Substitution

Any restrictions on medication substitution

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
allowed	Boolean Whether substitution is allowed or not
reason	CodeableConcept Why should (not) substitution be made

MedicationRequestIntentCode

The kind of medication order See http://hl7.org/fhir/ValueSet/medication-request-intent

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PROPOSAL
PLAN
ORDER
INSTANCE_ORDER

MedicationRequestPriorityCode

Identifies the level of importance to be assigned to actioning the request See http://hl7.org/fhir/ValueSet/medication-request-priority

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ROUTINE
URGENT
STAT
ASAP

MedicationRequestStatusCode

A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription See http://hl7.org/fhir/ValueSet/medication-request-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
ON_HOLD
CANCELLED
COMPLETED
ENTERED_IN_ERROR
STOPPED
DRAFT
UNKNOWN

MedicationStatement

Auto-generated from StructureDefinition for MedicationStatement, last updated 2017-04-19T07:44:43.294+10:00. Record of medication being taken by a patient. See http://hl7.org/fhir/StructureDefinition/MedicationStatement

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External identifier
based_on[]	Reference Fulfils plan, proposal or order
part_of[]	Reference Part of referenced event
context	Reference Encounter / Episode associated with MedicationStatement
status	MedicationStatementStatusCode active | completed | entered-in-error | intended | stopped | on-hold
category	CodeableConcept Type of medication usage
medication	Medication
effective	Effective
date_asserted	DateTime When the statement was asserted?
information_source	Reference Person or organization that provided the information about the taking of this medication
subject	Reference Who is/was taking the medication
derived_from[]	Reference Additional supporting information
taken	MedicationStatementTakenCode y | n | unk | na
reason_not_taken[]	CodeableConcept True if asserting medication was not given
reason_code[]	CodeableConcept Reason for why the medication is being/was taken
reason_reference[]	Reference Condition or observation that supports why the medication is being/was taken
note[]	Annotation Further information about the statement
dosage[]	Dosage Details of how medication is/was taken or should be taken

Effective

The date/time or interval when the medication was taken

Fields
Union field effective. effective can be only one of the following:
date_time	DateTime
period	Period

Medication

What medication was taken

Fields
Union field medication. medication can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

MedicationStatementStatusCode

A coded concept indicating the current status of a MedicationStatement. See http://hl7.org/fhir/ValueSet/medication-statement-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
COMPLETED
ENTERED_IN_ERROR
INTENDED
STOPPED
ON_HOLD

MedicationStatementTakenCode

A coded concept identifying level of certainty if patient has taken or has not taken the medication See http://hl7.org/fhir/ValueSet/medication-statement-taken

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
Y
N
UNK
NA

MedicationStatusCode

A coded concept defining if the medication is in active use See http://hl7.org/fhir/ValueSet/medication-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
INACTIVE
ENTERED_IN_ERROR

MessageDefinition

Auto-generated from StructureDefinition for MessageDefinition, last updated 2017-04-19T07:44:43.294+10:00. A resource that defines a type of message that can be exchanged between systems. See http://hl7.org/fhir/StructureDefinition/MessageDefinition

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this message definition (globally unique)
identifier	Identifier Additional identifier for the message definition
version	String Business version of the message definition
name	String Name for this message definition (computer friendly)
title	String Name for this message definition (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the message definition
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for message definition (if applicable)
purpose	Markdown Why this message definition is defined
copyright	Markdown Use and/or publishing restrictions
base	Reference Definition this one is based on
parent[]	Reference Protocol/workflow this is part of
replaces[]	Reference Takes the place of
event	Coding Event type
category	MessageSignificanceCategoryCode Consequence | Currency | Notification
focus[]	Focus
response_required	Boolean Is a response required?
allowed_response[]	AllowedResponse

AllowedResponse

Responses to this message

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
message	Reference Reference to allowed message definition response
situation	Markdown When should this response be used

Focus

Resource(s) that are the subject of the event

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	ResourceTypeCode Type of resource
profile	Reference Profile that must be adhered to by focus
min	UnsignedInt Minimum number of focuses of this type
max	String Maximum number of focuses of this type

MessageHeader

Auto-generated from StructureDefinition for MessageHeader, last updated 2017-04-19T07:44:43.294+10:00. A resource that describes a message that is exchanged between systems. See http://hl7.org/fhir/StructureDefinition/MessageHeader

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
event	Coding Code for the event this message represents
destination[]	MessageDestination
receiver	Reference Intended "real-world" recipient for the data
sender	Reference Real world sender of the message
timestamp	Instant Time that the message was sent
enterer	Reference The source of the data entry
author	Reference The source of the decision
source	MessageSource
responsible	Reference Final responsibility for event
reason	CodeableConcept Cause of event
response	Response
focus[]	Reference The actual content of the message

MessageDestination

Message destination application(s)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Name of system
target	Reference Particular delivery destination within the destination
endpoint	Uri Actual destination address or id

MessageSource

Message source application

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Name of system
software	String Name of software running the system
version	String Version of software running
contact	ContactPoint Human contact for problems
endpoint	Uri Actual message source address or id

Response

If this is a reply to prior message

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Id Id of original message
code	ResponseTypeCode ok | transient-error | fatal-error
details	Reference Specific list of hints/warnings/errors

MessageSignificanceCategoryCode

The impact of the content of a message. See http://hl7.org/fhir/ValueSet/message-significance-category

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CONSEQUENCE
CURRENCY
NOTIFICATION

Meta

Auto-generated from StructureDefinition for Meta, last updated 2017-04-19T07:44:43.294+10:00. Metadata about a resource. See http://hl7.org/fhir/StructureDefinition/Meta

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
version_id	Id Version specific identifier
last_updated	Instant When the resource version last changed
profile[]	Uri Profiles this resource claims to conform to
security[]	Coding Security Labels applied to this resource
tag[]	Coding Tags applied to this resource

MimeTypeCode

Any valid MimeType. See http://www.rfc-editor.org/bcp/bcp13.txt

Fields
value	string Primitive value for code
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Money

Auto-generated from StructureDefinition for Money, last updated 2017-04-19T07:44:43.294+10:00. An amount of economic utility in some recognized currency. See http://hl7.org/fhir/StructureDefinition/Money

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
value	Decimal Numerical value (with implicit precision)
comparator	QuantityComparatorCode < | <= | >= | > - how to understand the value
unit	String Unit representation
system	Uri System that defines coded unit form
code	Code Coded form of the unit

NameUseCode

The use of a human name See http://hl7.org/fhir/ValueSet/name-use

Fields
value	Value
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
USUAL
OFFICIAL
TEMP
NICKNAME
ANONYMOUS
OLD
MAIDEN

NamingSystem

Auto-generated from StructureDefinition for NamingSystem, last updated 2017-04-19T07:44:43.294+10:00. System of unique identification. See http://hl7.org/fhir/StructureDefinition/NamingSystem

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Name for this naming system (computer friendly)
status	PublicationStatusCode draft | active | retired | unknown
kind	NamingSystemTypeCode codesystem | identifier | root
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
responsible	String Who maintains system namespace?
type	CodeableConcept e.g. driver, provider, patient, bank etc.
description	Markdown Natural language description of the naming system
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for naming system (if applicable)
usage	String How/where is it used
unique_id[]	UniqueId
replaced_by	Reference Use this instead

UniqueId

Unique identifiers used for system

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	NamingSystemIdentifierTypeCode oid | uuid | uri | other
value	String The unique identifier
preferred	Boolean Is this the id that should be used for this type
comment	String Notes about identifier usage
period	Period When is identifier valid?

NamingSystemIdentifierTypeCode

Identifies the style of unique identifier used to identify a namespace. See http://hl7.org/fhir/ValueSet/namingsystem-identifier-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
OID
UUID
URI
OTHER

NamingSystemTypeCode

Identifies the purpose of the naming system. See http://hl7.org/fhir/ValueSet/namingsystem-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CODESYSTEM
IDENTIFIER
ROOT

Narrative

Auto-generated from StructureDefinition for Narrative, last updated 2017-04-19T07:44:43.294+10:00. A human-readable formatted text, including images. See http://hl7.org/fhir/StructureDefinition/Narrative

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
status	NarrativeStatusCode generated | extensions | additional | empty
div	Xhtml Limited xhtml content

NarrativeStatusCode

The status of a resource narrative See http://hl7.org/fhir/ValueSet/narrative-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
GENERATED
EXTENSIONS
ADDITIONAL
EMPTY

NutritionOrder

Auto-generated from StructureDefinition for NutritionOrder, last updated 2017-04-19T07:44:43.294+10:00. Diet, formula or nutritional supplement request. See http://hl7.org/fhir/StructureDefinition/NutritionOrder

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Identifiers assigned to this order
status	NutritionOrderStatusCode proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error
patient	Reference The person who requires the diet, formula or nutritional supplement
encounter	Reference The encounter associated with this nutrition order
date_time	DateTime Date and time the nutrition order was requested
orderer	Reference Who ordered the diet, formula or nutritional supplement
allergy_intolerance[]	Reference List of the patient's food and nutrition-related allergies and intolerances
food_preference_modifier[]	CodeableConcept Order-specific modifier about the type of food that should be given
exclude_food_modifier[]	CodeableConcept Order-specific modifier about the type of food that should not be given
oral_diet	OralDiet
supplement[]	Supplement
enteral_formula	EnteralFormula

EnteralFormula

Enteral formula components

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
base_formula_type	CodeableConcept Type of enteral or infant formula
base_formula_product_name	String Product or brand name of the enteral or infant formula
additive_type	CodeableConcept Type of modular component to add to the feeding
additive_product_name	String Product or brand name of the modular additive
caloric_density	SimpleQuantity Amount of energy per specified volume that is required
routeof_administration	CodeableConcept How the formula should enter the patient's gastrointestinal tract
administration[]	Administration
max_volume_to_deliver	SimpleQuantity Upper limit on formula volume per unit of time
administration_instruction	String Formula feeding instructions expressed as text

Administration

Formula feeding instruction as structured data

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
schedule	Timing Scheduled frequency of enteral feeding
quantity	SimpleQuantity The volume of formula to provide
rate	Rate

Rate

Speed with which the formula is provided per period of time

Fields
Union field rate. rate can be only one of the following:
quantity	SimpleQuantity
ratio	Ratio

OralDiet

Oral diet components

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type[]	CodeableConcept Type of oral diet or diet restrictions that describe what can be consumed orally
schedule[]	Timing Scheduled frequency of diet
nutrient[]	Nutrient
texture[]	Texture
fluid_consistency_type[]	CodeableConcept The required consistency of fluids and liquids provided to the patient
instruction	String Instructions or additional information about the oral diet

Nutrient

Required nutrient modifications

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
modifier	CodeableConcept Type of nutrient that is being modified
amount	SimpleQuantity Quantity of the specified nutrient

Texture

Required texture modifications

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
modifier	CodeableConcept Code to indicate how to alter the texture of the foods, e.g. pureed
food_type	CodeableConcept Concepts that are used to identify an entity that is ingested for nutritional purposes

Supplement

Supplement components

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept Type of supplement product requested
product_name	String Product or brand name of the nutritional supplement
schedule[]	Timing Scheduled frequency of supplement
quantity	SimpleQuantity Amount of the nutritional supplement
instruction	String Instructions or additional information about the oral supplement

NutritionOrderStatusCode

Codes specifying the state of the request. Describes the lifecycle of the nutrition order. See http://hl7.org/fhir/ValueSet/nutrition-request-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PROPOSED
DRAFT
PLANNED
REQUESTED
ACTIVE
ON_HOLD
COMPLETED
CANCELLED
ENTERED_IN_ERROR

Observation

Auto-generated from StructureDefinition for Observation, last updated 2017-04-19T07:44:43.294+10:00. Measurements and simple assertions. See http://hl7.org/fhir/StructureDefinition/Observation

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier for observation
based_on[]	Reference Fulfills plan, proposal or order
status	ObservationStatusCode registered | preliminary | final | amended +
category[]	CodeableConcept Classification of type of observation
code	CodeableConcept Type of observation (code / type)
subject	Reference Who and/or what this is about
context	Reference Healthcare event during which this observation is made
effective	Effective
issued	Instant Date/Time this was made available
performer[]	Reference Who is responsible for the observation
value	Value
data_absent_reason	CodeableConcept Why the result is missing
interpretation	CodeableConcept High, low, normal, etc.
comment	String Comments about result
body_site	CodeableConcept Observed body part
method	CodeableConcept How it was done
specimen	Reference Specimen used for this observation
device	Reference (Measurement) Device
reference_range[]	ReferenceRange
related[]	Related
component[]	Component

Component

Component results

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	CodeableConcept Type of component observation (code / type)
value	Value
data_absent_reason	CodeableConcept Why the component result is missing
interpretation	CodeableConcept High, low, normal, etc.
reference_range[]	ReferenceRange Provides guide for interpretation of component result

Value

Actual component result

Fields
Union field value. value can be only one of the following:
quantity	Quantity
codeable_concept	CodeableConcept
string_value	String
range	Range
ratio	Ratio
sampled_data	SampledData
attachment	Attachment
time	Time
date_time	DateTime
period	Period

Effective

Clinically relevant time/time-period for observation

Fields
Union field effective. effective can be only one of the following:
date_time	DateTime
period	Period

ReferenceRange

Provides guide for interpretation

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
low	SimpleQuantity Low Range, if relevant
high	SimpleQuantity High Range, if relevant
type	CodeableConcept Reference range qualifier
applies_to[]	CodeableConcept Reference range population
age	Range Applicable age range, if relevant
text	String Text based reference range in an observation

Related

Resource related to this observation

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	ObservationRelationshipTypeCode has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
target	Reference Resource that is related to this one

Value

Actual result

Fields
Union field value. value can be only one of the following:
quantity	Quantity
codeable_concept	CodeableConcept
string_value	String
boolean	Boolean
range	Range
ratio	Ratio
sampled_data	SampledData
attachment	Attachment
time	Time
date_time	DateTime
period	Period

ObservationRelationshipTypeCode

Codes specifying how two observations are related. See http://hl7.org/fhir/ValueSet/observation-relationshiptypes

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
HAS_MEMBER
DERIVED_FROM
SEQUEL_TO
REPLACES
QUALIFIED_BY
INTERFERED_BY

ObservationStatusCode

Codes providing the status of an observation. See http://hl7.org/fhir/ValueSet/observation-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
REGISTERED
PRELIMINARY
FINAL
AMENDED
CORRECTED
CANCELLED
ENTERED_IN_ERROR
UNKNOWN

Oid

Auto-generated from StructureDefinition for oid, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type oid. See http://hl7.org/fhir/StructureDefinition/oid

Fields
value	string Primitive value for oid
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

OperationDefinition

Auto-generated from StructureDefinition for OperationDefinition, last updated 2017-04-19T07:44:43.294+10:00. Definition of an operation or a named query. See http://hl7.org/fhir/StructureDefinition/OperationDefinition

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this operation definition (globally unique)
version	String Business version of the operation definition
name	String Name for this operation definition (computer friendly)
status	PublicationStatusCode draft | active | retired | unknown
kind	OperationKindCode operation | query
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the operation definition
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for operation definition (if applicable)
purpose	Markdown Why this operation definition is defined
idempotent	Boolean Whether content is unchanged by the operation
code	Code Name used to invoke the operation
comment	String Additional information about use
base	Reference Marks this as a profile of the base
resource[]	ResourceTypeCode Types this operation applies to
system	Boolean Invoke at the system level?
type	Boolean Invole at the type level?
instance	Boolean Invoke on an instance?
parameter[]	Parameter
overload[]	Overload

Overload

Define overloaded variants for when generating code

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
parameter_name[]	String Name of parameter to include in overload
comment	String Comments to go on overload

Parameter

Parameters for the operation/query

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	Code Name in Parameters.parameter.name or in URL
use	OperationParameterUseCode in | out
min	Integer Minimum Cardinality
max	String Maximum Cardinality (a number or *)
documentation	String Description of meaning/use
type	FHIRAllTypesCode What type this parameter has
search_type	SearchParamTypeCode number | date | string | token | reference | composite | quantity | uri
profile	Reference Profile on the type
binding	Binding
part[]	Parameter Parts of a nested Parameter

Binding

ValueSet details if this is coded

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
strength	BindingStrengthCode required | extensible | preferred | example
value_set	ValueSet

ValueSet

Source of value set

Fields
Union field value_set. value_set can be only one of the following:
uri	Uri
reference	Reference

OperationKindCode

Whether an operation is a normal operation or a query. See http://hl7.org/fhir/ValueSet/operation-kind

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
OPERATION
QUERY

OperationOutcome

Auto-generated from StructureDefinition for OperationOutcome, last updated 2017-04-19T07:44:43.294+10:00. Information about the success/failure of an action. See http://hl7.org/fhir/StructureDefinition/OperationOutcome

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
issue[]	Issue

Issue

A single issue associated with the action

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
severity	IssueSeverityCode fatal | error | warning | information
code	IssueTypeCode Error or warning code
details	CodeableConcept Additional details about the error
diagnostics	String Additional diagnostic information about the issue
location[]	String Path of element(s) related to issue
expression[]	String FHIRPath of element(s) related to issue

OperationParameterUseCode

Whether an operation parameter is an input or an output parameter. See http://hl7.org/fhir/ValueSet/operation-parameter-use

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
IN
OUT

Organization

Auto-generated from StructureDefinition for Organization, last updated 2017-04-19T07:44:43.294+10:00. A grouping of people or organizations with a common purpose. See http://hl7.org/fhir/StructureDefinition/Organization

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Identifies this organization across multiple systems
active	Boolean Whether the organization's record is still in active use
type[]	CodeableConcept Kind of organization
name	String Name used for the organization
alias[]	String A list of alternate names that the organization is known as, or was known as in the past
telecom[]	ContactPoint A contact detail for the organization
address[]	Address An address for the organization
part_of	Reference The organization of which this organization forms a part
contact[]	Contact
endpoint[]	Reference Technical endpoints providing access to services operated for the organization

Contact

Contact for the organization for a certain purpose

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
purpose	CodeableConcept The type of contact
name	HumanName A name associated with the contact
telecom[]	ContactPoint Contact details (telephone, email, etc.) for a contact
address	Address Visiting or postal addresses for the contact

ParameterDefinition

Auto-generated from StructureDefinition for ParameterDefinition, last updated 2017-04-19T07:44:43.294+10:00. Definition of a parameter to a module. See http://hl7.org/fhir/StructureDefinition/ParameterDefinition

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
name	Code Name used to access the parameter value
use	OperationParameterUseCode in | out
min	Integer Minimum cardinality
max	String Maximum cardinality (a number of *)
documentation	String A brief description of the parameter
type	FHIRAllTypesCode What type of value
profile	Reference What profile the value is expected to be

Parameters

Auto-generated from StructureDefinition for Parameters, last updated 2017-04-19T07:44:43.294+10:00. Operation Request or Response. See http://hl7.org/fhir/StructureDefinition/Parameters

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
parameter[]	Parameter

Parameter

Operation Parameter

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Name from the definition
value	Value
resource	ContainedResource If parameter is a whole resource
part[]	Parameter Named part of a multi-part parameter

Value

If parameter is a data type

Fields
Union field value. value can be only one of the following:
base64_binary	Base64Binary
boolean	Boolean
code	Code
date	Date
date_time	DateTime
decimal	Decimal
id	Id
instant	Instant
integer	Integer
markdown	Markdown
oid	Oid
positive_int	PositiveInt
string_value	String
time	Time
unsigned_int	UnsignedInt
uri	Uri
address	Address
age	Age
annotation	Annotation
attachment	Attachment
codeable_concept	CodeableConcept
coding	Coding
contact_point	ContactPoint
count	Count
distance	Distance
duration	Duration
human_name	HumanName
identifier	Identifier
money	Money
period	Period
quantity	Quantity
range	Range
ratio	Ratio
reference	Reference
sampled_data	SampledData
signature	Signature
timing	Timing
meta	Meta

ParticipantRequiredCode

Is the Participant required to attend the appointment. See http://hl7.org/fhir/ValueSet/participantrequired

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
REQUIRED
OPTIONAL
INFORMATION_ONLY

ParticipationStatusCode

The Participation status of an appointment. See http://hl7.org/fhir/ValueSet/participationstatus

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACCEPTED
DECLINED
TENTATIVE
NEEDS_ACTION

Patient

Auto-generated from StructureDefinition for Patient, last updated 2017-04-19T07:44:43.294+10:00. Information about an individual or animal receiving health care services. See http://hl7.org/fhir/StructureDefinition/Patient

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier An identifier for this patient
active	Boolean Whether this patient's record is in active use
name[]	HumanName A name associated with the patient
telecom[]	ContactPoint A contact detail for the individual
gender	AdministrativeGenderCode male | female | other | unknown
birth_date	Date The date of birth for the individual
deceased	Deceased
address[]	Address Addresses for the individual
marital_status	CodeableConcept Marital (civil) status of a patient
multiple_birth	MultipleBirth
photo[]	Attachment Image of the patient
contact[]	Contact
animal	Animal
communication[]	Communication
general_practitioner[]	Reference Patient's nominated primary care provider
managing_organization	Reference Organization that is the custodian of the patient record
link[]	Link

Animal

This patient is known to be an animal (non-human)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
species	CodeableConcept E.g. Dog, Cow
breed	CodeableConcept E.g. Poodle, Angus
gender_status	CodeableConcept E.g. Neutered, Intact

Communication

A list of Languages which may be used to communicate with the patient about his or her health

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
language	CodeableConcept The language which can be used to communicate with the patient about his or her health
preferred	Boolean Language preference indicator

Contact

A contact party (e.g. guardian, partner, friend) for the patient

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
relationship[]	CodeableConcept The kind of relationship
name	HumanName A name associated with the contact person
telecom[]	ContactPoint A contact detail for the person
address	Address Address for the contact person
gender	AdministrativeGenderCode male | female | other | unknown
organization	Reference Organization that is associated with the contact
period	Period The period during which this contact person or organization is valid to be contacted relating to this patient

Deceased

Indicates if the individual is deceased or not

Fields
Union field deceased. deceased can be only one of the following:
boolean	Boolean
date_time	DateTime

Link

Link to another patient resource that concerns the same actual person

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
other	Reference The other patient or related person resource that the link refers to
type	LinkTypeCode replaced-by | replaces | refer | seealso - type of link

MultipleBirth

Whether patient is part of a multiple birth

Fields
Union field multiple_birth. multiple_birth can be only one of the following:
boolean	Boolean
integer	Integer

PaymentNotice

Auto-generated from StructureDefinition for PaymentNotice, last updated 2017-04-19T07:44:43.294+10:00. PaymentNotice request. See http://hl7.org/fhir/StructureDefinition/PaymentNotice

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
request	Reference Request reference
response	Reference Response reference
status_date	Date Payment or clearing date
created	DateTime Creation date
target	Reference Insurer or Regulatory body
provider	Reference Responsible practitioner
organization	Reference Responsible organization
payment_status	CodeableConcept Whether payment has been sent or cleared

PaymentReconciliation

Auto-generated from StructureDefinition for PaymentReconciliation, last updated 2017-04-19T07:44:43.294+10:00. PaymentReconciliation resource. See http://hl7.org/fhir/StructureDefinition/PaymentReconciliation

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
period	Period Period covered
created	DateTime Creation date
organization	Reference Insurer
request	Reference Claim reference
outcome	CodeableConcept complete | error | partial
disposition	String Disposition Message
request_provider	Reference Responsible practitioner
request_organization	Reference Responsible organization
detail[]	Details
form	CodeableConcept Printed Form Identifier
total	Money Total amount of Payment
process_note[]	Notes

Details

List of settlements

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept Type code
request	Reference Claim
response	Reference Claim Response
submitter	Reference Organization which submitted the claim
payee	Reference Organization which is receiving the payment
date	Date Invoice date
amount	Money Amount being paid

Notes

Processing comments

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept display | print | printoper
text	String Comment on the processing

Period

Auto-generated from StructureDefinition for Period, last updated 2017-04-19T07:44:43.294+10:00. Time range defined by start and end date/time. See http://hl7.org/fhir/StructureDefinition/Period

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
start	DateTime Starting time with inclusive boundary
end	DateTime End time with inclusive boundary, if not ongoing

Person

Auto-generated from StructureDefinition for Person, last updated 2017-04-19T07:44:43.294+10:00. A generic person record. See http://hl7.org/fhir/StructureDefinition/Person

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier A human identifier for this person
name[]	HumanName A name associated with the person
telecom[]	ContactPoint A contact detail for the person
gender	AdministrativeGenderCode male | female | other | unknown
birth_date	Date The date on which the person was born
address[]	Address One or more addresses for the person
photo	Attachment Image of the person
managing_organization	Reference The organization that is the custodian of the person record
active	Boolean This person's record is in active use
link[]	Link

Link

Link to a resource that concerns the same actual person

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
target	Reference The resource to which this actual person is associated
assurance	IdentityAssuranceLevelCode level1 | level2 | level3 | level4

PlanDefinition

Auto-generated from StructureDefinition for PlanDefinition, last updated 2017-04-19T07:44:43.294+10:00. The definition of a plan for a series of actions, independent of any specific patient or context. See http://hl7.org/fhir/StructureDefinition/PlanDefinition

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this plan definition (globally unique)
identifier[]	Identifier Additional identifier for the plan definition
version	String Business version of the plan definition
name	String Name for this plan definition (computer friendly)
title	String Name for this plan definition (human friendly)
type	CodeableConcept order-set | protocol | eca-rule
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
description	Markdown Natural language description of the plan definition
purpose	Markdown Why this plan definition is defined
usage	String Describes the clinical usage of the asset
approval_date	Date When the plan definition was approved by publisher
last_review_date	Date When the plan definition was last reviewed
effective_period	Period When the plan definition is expected to be used
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for plan definition (if applicable)
topic[]	CodeableConcept E.g. Education, Treatment, Assessment, etc
contributor[]	Contributor A content contributor
contact[]	ContactDetail Contact details for the publisher
copyright	Markdown Use and/or publishing restrictions
related_artifact[]	RelatedArtifact Related artifacts for the asset
library[]	Reference Logic used by the plan definition
goal[]	Goal
action[]	Action

Action

Action defined by the plan

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
label	String User-visible label for the action (e.g. 1. or A.)
title	String User-visible title
description	String Short description of the action
text_equivalent	String Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
code[]	CodeableConcept Code representing the meaning of the action or sub-actions
reason[]	CodeableConcept Why the action should be performed
documentation[]	RelatedArtifact Supporting documentation for the intended performer of the action
goal_id[]	Id What goals this action supports
trigger_definition[]	TriggerDefinition When the action should be triggered
condition[]	Condition
input[]	DataRequirement Input data requirements
output[]	DataRequirement Output data definition
related_action[]	RelatedAction
timing	TimingType
participant[]	Participant
type	Coding create | update | remove | fire-event
grouping_behavior	ActionGroupingBehaviorCode visual-group | logical-group | sentence-group
selection_behavior	ActionSelectionBehaviorCode any | all | all-or-none | exactly-one | at-most-one | one-or-more
required_behavior	ActionRequiredBehaviorCode must | could | must-unless-documented
precheck_behavior	ActionPrecheckBehaviorCode yes | no
cardinality_behavior	ActionCardinalityBehaviorCode single | multiple
definition	Reference Description of the activity to be performed
transform	Reference Transform to apply the template
dynamic_value[]	DynamicValue
action[]	Action A sub-action

Condition

Whether or not the action is applicable

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
kind	ActionConditionKindCode applicability | start | stop
description	String Natural language description of the condition
language	String Language of the expression
expression	String Boolean-valued expression

DynamicValue

Dynamic aspects of the definition

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
description	String Natural language description of the dynamic value
path	String The path to the element to be set dynamically
language	String Language of the expression
expression	String An expression that provides the dynamic value for the customization

Participant

Who should participate in the action

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	ActionParticipantTypeCode patient | practitioner | related-person
role	CodeableConcept E.g. Nurse, Surgeon, Parent, etc

RelatedAction

Relationship to another action

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
action_id	Id What action is this related to
relationship	ActionRelationshipTypeCode before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
offset	Offset

Offset

Time offset for the relationship

Fields
Union field offset. offset can be only one of the following:
duration	Duration
range	Range

TimingType

When the action should take place

Fields
Union field timing. timing can be only one of the following:
date_time	DateTime
period	Period
duration	Duration
range	Range
timing_value	Timing

Goal

What the plan is trying to accomplish

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
category	CodeableConcept E.g. Treatment, dietary, behavioral, etc
description	CodeableConcept Code or text describing the goal
priority	CodeableConcept high-priority | medium-priority | low-priority
start	CodeableConcept When goal pursuit begins
addresses[]	CodeableConcept What does the goal address
documentation[]	RelatedArtifact Supporting documentation for the goal
target[]	Target

Target

Target outcome for the goal

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
measure	CodeableConcept The parameter whose value is to be tracked
detail	Detail
due	Duration Reach goal within

Detail

The target value to be achieved

Fields
Union field detail. detail can be only one of the following:
quantity	Quantity
range	Range
codeable_concept	CodeableConcept

PositiveInt

Auto-generated from StructureDefinition for positiveInt, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type positiveInt. See http://hl7.org/fhir/StructureDefinition/positiveInt

Fields
value	uint32 Primitive value for positiveInt
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Practitioner

Auto-generated from StructureDefinition for Practitioner, last updated 2017-04-19T07:44:43.294+10:00. A person with a formal responsibility in the provisioning of healthcare or related services. See http://hl7.org/fhir/StructureDefinition/Practitioner

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier A identifier for the person as this agent
active	Boolean Whether this practitioner's record is in active use
name[]	HumanName The name(s) associated with the practitioner
telecom[]	ContactPoint A contact detail for the practitioner (that apply to all roles)
address[]	Address Address(es) of the practitioner that are not role specific (typically home address)
gender	AdministrativeGenderCode male | female | other | unknown
birth_date	Date The date on which the practitioner was born
photo[]	Attachment Image of the person
qualification[]	Qualification
communication[]	CodeableConcept A language the practitioner is able to use in patient communication

Qualification

Qualifications obtained by training and certification

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier An identifier for this qualification for the practitioner
code	CodeableConcept Coded representation of the qualification
period	Period Period during which the qualification is valid
issuer	Reference Organization that regulates and issues the qualification

PractitionerRole

Auto-generated from StructureDefinition for PractitionerRole, last updated 2017-04-19T07:44:43.294+10:00. Roles/organizations the practitioner is associated with. See http://hl7.org/fhir/StructureDefinition/PractitionerRole

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifiers that are specific to a role/location
active	Boolean Whether this practitioner's record is in active use
period	Period The period during which the practitioner is authorized to perform in these role(s)
practitioner	Reference Practitioner that is able to provide the defined services for the organation
organization	Reference Organization where the roles are available
code[]	CodeableConcept Roles which this practitioner may perform
specialty[]	CodeableConcept Specific specialty of the practitioner
location[]	Reference The location(s) at which this practitioner provides care
healthcare_service[]	Reference The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom[]	ContactPoint Contact details that are specific to the role/location/service
available_time[]	AvailableTime
not_available[]	NotAvailable
availability_exceptions	String Description of availability exceptions
endpoint[]	Reference Technical endpoints providing access to services operated for the practitioner with this role

AvailableTime

Times the Service Site is available

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
days_of_week[]	DaysOfWeekCode mon | tue | wed | thu | fri | sat | sun
all_day	Boolean Always available? e.g. 24 hour service
available_start_time	Time Opening time of day (ignored if allDay = true)
available_end_time	Time Closing time of day (ignored if allDay = true)

NotAvailable

Not available during this time due to provided reason

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
description	String Reason presented to the user explaining why time not available
during	Period Service not availablefrom this date

Procedure

Auto-generated from StructureDefinition for Procedure, last updated 2017-04-19T07:44:43.294+10:00. An action that is being or was performed on a patient. See http://hl7.org/fhir/StructureDefinition/Procedure

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Identifiers for this procedure
definition[]	Reference Instantiates protocol or definition
based_on[]	Reference A request for this procedure
part_of[]	Reference Part of referenced event
status	EventStatusCode preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
not_done	Boolean True if procedure was not performed as scheduled
not_done_reason	CodeableConcept Reason procedure was not performed
category	CodeableConcept Classification of the procedure
code	CodeableConcept Identification of the procedure
subject	Reference Who the procedure was performed on
context	Reference Encounter or episode associated with the procedure
performed	Performed
performer[]	Performer
location	Reference Where the procedure happened
reason_code[]	CodeableConcept Coded reason procedure performed
reason_reference[]	Reference Condition that is the reason the procedure performed
body_site[]	CodeableConcept Target body sites
outcome	CodeableConcept The result of procedure
report[]	Reference Any report resulting from the procedure
complication[]	CodeableConcept Complication following the procedure
complication_detail[]	Reference A condition that is a result of the procedure
follow_up[]	CodeableConcept Instructions for follow up
note[]	Annotation Additional information about the procedure
focal_device[]	FocalDevice
used_reference[]	Reference Items used during procedure
used_code[]	CodeableConcept Coded items used during the procedure

FocalDevice

Device changed in procedure

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
action	CodeableConcept Kind of change to device
manipulated	Reference Device that was changed

Performed

Date/Period the procedure was performed

Fields
Union field performed. performed can be only one of the following:
date_time	DateTime
period	Period

Performer

The people who performed the procedure

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
role	CodeableConcept The role the actor was in
actor	Reference The reference to the practitioner
on_behalf_of	Reference Organization the device or practitioner was acting for

ProcedureRequest

Auto-generated from StructureDefinition for ProcedureRequest, last updated 2017-04-19T07:44:43.294+10:00. A request for a procedure or diagnostic to be performed. See http://hl7.org/fhir/StructureDefinition/ProcedureRequest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Identifiers assigned to this order
definition[]	Reference Protocol or definition
based_on[]	Reference What request fulfills
replaces[]	Reference What request replaces
requisition	Identifier Composite Request ID
status	RequestStatusCode draft | active | suspended | completed | entered-in-error | cancelled
intent	RequestIntentCode proposal | plan | order +
priority	RequestPriorityCode routine | urgent | asap | stat
do_not_perform	Boolean True if procedure should not be performed
category[]	CodeableConcept Classification of procedure
code	CodeableConcept What is being requested/ordered
subject	Reference Individual the service is ordered for
context	Reference Encounter or Episode during which request was created
occurrence	Occurrence
as_needed	AsNeeded
authored_on	DateTime Date request signed
requester	Requester
performer_type	CodeableConcept Performer role
performer	Reference Requested perfomer
reason_code[]	CodeableConcept Explanation/Justification for test
reason_reference[]	Reference Explanation/Justification for test
supporting_info[]	Reference Additional clinical information
specimen[]	Reference Procedure Samples
body_site[]	CodeableConcept Location on Body
note[]	Annotation Comments
relevant_history[]	Reference Request provenance

AsNeeded

Preconditions for procedure or diagnostic

Fields
Union field as_needed. as_needed can be only one of the following:
boolean	Boolean
codeable_concept	CodeableConcept

Occurrence

When procedure should occur

Fields
Union field occurrence. occurrence can be only one of the following:
date_time	DateTime
period	Period
timing	Timing

Requester

Who/what is requesting procedure or diagnostic

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
agent	Reference Individual making the request
on_behalf_of	Reference Organization agent is acting for

ProcessRequest

Auto-generated from StructureDefinition for ProcessRequest, last updated 2017-04-19T07:44:43.294+10:00. Request to perform some action on or in regards to an existing resource. See http://hl7.org/fhir/StructureDefinition/ProcessRequest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
action	ActionListCode cancel | poll | reprocess | status
target	Reference Party which is the target of the request
created	DateTime Creation date
provider	Reference Responsible practitioner
organization	Reference Responsible organization
request	Reference Reference to the Request resource
response	Reference Reference to the Response resource
nullify	Boolean Remove history
reference	String Reference number/string
item[]	Items
include[]	String Resource type(s) to include
exclude[]	String Resource type(s) to exclude
period	Period Selection period

Items

Items to re-adjudicate

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
sequence_link_id	Integer Service instance

ProcessResponse

Auto-generated from StructureDefinition for ProcessResponse, last updated 2017-04-19T07:44:43.294+10:00. ProcessResponse resource. See http://hl7.org/fhir/StructureDefinition/ProcessResponse

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
created	DateTime Creation date
organization	Reference Authoring Organization
request	Reference Request reference
outcome	CodeableConcept Processing outcome
disposition	String Disposition Message
request_provider	Reference Responsible Practitioner
request_organization	Reference Responsible organization
form	CodeableConcept Printed Form Identifier
process_note[]	ProcessNote
error[]	CodeableConcept Error code
communication_request[]	Reference Request for additional information

ProcessNote

Processing comments or additional requirements

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept display | print | printoper
text	String Comment on the processing

PropertyRepresentationCode

How a property is represented when serialized. See http://hl7.org/fhir/ValueSet/property-representation

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
XML_ATTR
XML_TEXT
TYPE_ATTR
CDA_TEXT
XHTML

PropertyTypeCode

The type of a property value See http://hl7.org/fhir/ValueSet/concept-property-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CODE
CODING
STRING
INTEGER
BOOLEAN
DATETIME

Provenance

Auto-generated from StructureDefinition for Provenance, last updated 2017-04-19T07:44:43.294+10:00. Who, What, When for a set of resources. See http://hl7.org/fhir/StructureDefinition/Provenance

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
target[]	Reference Target Reference(s) (usually version specific)
period	Period When the activity occurred
recorded	Instant When the activity was recorded / updated
policy[]	Uri Policy or plan the activity was defined by
location	Reference Where the activity occurred, if relevant
reason[]	Coding Reason the activity is occurring
activity	Coding Activity that occurred
agent[]	Agent
entity[]	Entity
signature[]	Signature Signature on target

Agent

Actor involved

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
role[]	CodeableConcept What the agents role was
who	Who
on_behalf_of	OnBehalfOf
related_agent_type	CodeableConcept Type of relationship between agents

OnBehalfOf

Who the agent is representing

Fields
Union field on_behalf_of. on_behalf_of can be only one of the following:
uri	Uri
reference	Reference

Who

Who participated

Fields
Union field who. who can be only one of the following:
uri	Uri
reference	Reference

Entity

An entity used in this activity

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
role	ProvenanceEntityRoleCode derivation | revision | quotation | source | removal
what	What
agent[]	Agent Entity is attributed to this agent

What

Identity of entity

Fields
Union field what. what can be only one of the following:
uri	Uri
reference	Reference
identifier	Identifier

ProvenanceEntityRoleCode

How an entity was used in an activity. See http://hl7.org/fhir/ValueSet/provenance-entity-role

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DERIVATION
REVISION
QUOTATION
SOURCE
REMOVAL

PublicationStatusCode

The lifecycle status of a Value Set or Concept Map. See http://hl7.org/fhir/ValueSet/publication-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DRAFT
ACTIVE
RETIRED
UNKNOWN

QualityTypeCode

Type for quality report See http://hl7.org/fhir/ValueSet/quality-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
INDEL
SNP
UNKNOWN

Quantity

Auto-generated from StructureDefinition for Quantity, last updated 2017-04-19T07:44:43.294+10:00. A measured or measurable amount. See http://hl7.org/fhir/StructureDefinition/Quantity

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
value	Decimal Numerical value (with implicit precision)
comparator	QuantityComparatorCode < | <= | >= | > - how to understand the value
unit	String Unit representation
system	Uri System that defines coded unit form
code	Code Coded form of the unit

QuantityComparatorCode

How the Quantity should be understood and represented. See http://hl7.org/fhir/ValueSet/quantity-comparator

Fields
value	Value
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
LT
LE
GE
GT

Questionnaire

Auto-generated from StructureDefinition for Questionnaire, last updated 2017-04-19T07:44:43.294+10:00. A structured set of questions. See http://hl7.org/fhir/StructureDefinition/Questionnaire

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this questionnaire (globally unique)
identifier[]	Identifier Additional identifier for the questionnaire
version	String Business version of the questionnaire
name	String Name for this questionnaire (computer friendly)
title	String Name for this questionnaire (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
description	Markdown Natural language description of the questionnaire
purpose	Markdown Why this questionnaire is defined
approval_date	Date When the questionnaire was approved by publisher
last_review_date	Date When the questionnaire was last reviewed
effective_period	Period When the questionnaire is expected to be used
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for questionnaire (if applicable)
contact[]	ContactDetail Contact details for the publisher
copyright	Markdown Use and/or publishing restrictions
code[]	Coding Concept that represents the overall questionnaire
subject_type[]	ResourceTypeCode Resource that can be subject of QuestionnaireResponse
item[]	Item

Item

Questions and sections within the Questionnaire

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
link_id	String Unique id for item in questionnaire
definition	Uri ElementDefinition - details for the item
code[]	Coding Corresponding concept for this item in a terminology
prefix	String E.g. "1(a)", "2.5.3"
text	String Primary text for the item
type	QuestionnaireItemTypeCode group | display | boolean | decimal | integer | date | dateTime +
enable_when[]	EnableWhen
required	Boolean Whether the item must be included in data results
repeats	Boolean Whether the item may repeat
read_only	Boolean Don't allow human editing
max_length	Integer No more than this many characters
options	Reference Valueset containing permitted answers
option[]	Option
initial	Initial
item[]	Item Nested questionnaire items

EnableWhen

Only allow data when

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
question	String Question that determines whether item is enabled
has_answer_value	Boolean Enable when answered or not
answer	Answer

Answer

Value question must have

Fields
Union field answer. answer can be only one of the following:
boolean	Boolean
decimal	Decimal
integer	Integer
date	Date
date_time	DateTime
time	Time
string_value	String
uri	Uri
attachment	Attachment
coding	Coding
quantity	Quantity
reference	Reference

Initial

Default value when item is first rendered

Fields
Union field initial. initial can be only one of the following:
boolean	Boolean
decimal	Decimal
integer	Integer
date	Date
date_time	DateTime
time	Time
string_value	String
uri	Uri
attachment	Attachment
coding	Coding
quantity	Quantity
reference	Reference

Option

Permitted answer

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
value	Value

Value

Answer value

Fields
Union field value. value can be only one of the following:
integer	Integer
date	Date
time	Time
string_value	String
coding	Coding

QuestionnaireItemTypeCode

Distinguishes groups from questions and display text and indicates data type for questions See http://hl7.org/fhir/ValueSet/item-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
GROUP
DISPLAY
QUESTION
BOOLEAN
DECIMAL
INTEGER
DATE
DATE_TIME
TIME
STRING
TEXT
URL
CHOICE
OPEN_CHOICE
ATTACHMENT
REFERENCE
QUANTITY

QuestionnaireResponse

Auto-generated from StructureDefinition for QuestionnaireResponse, last updated 2017-04-19T07:44:43.294+10:00. A structured set of questions and their answers. See http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Unique id for this set of answers
based_on[]	Reference Request fulfilled by this QuestionnaireResponse
parent[]	Reference Part of this action
questionnaire	Reference Form being answered
status	QuestionnaireResponseStatusCode in-progress | completed | amended | entered-in-error | stopped
subject	Reference The subject of the questions
context	Reference Encounter or Episode during which questionnaire was completed
authored	DateTime Date the answers were gathered
author	Reference Person who received and recorded the answers
source	Reference The person who answered the questions
item[]	Item

Item

Groups and questions

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
link_id	String Pointer to specific item from Questionnaire
definition	Uri ElementDefinition - details for the item
text	String Name for group or question text
subject	Reference The subject this group's answers are about
answer[]	Answer
item[]	Item Nested questionnaire response items

Answer

The response(s) to the question

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
value	Value
item[]	Item Nested groups and questions

Value

Single-valued answer to the question

Fields
Union field value. value can be only one of the following:
boolean	Boolean
decimal	Decimal
integer	Integer
date	Date
date_time	DateTime
time	Time
string_value	String
uri	Uri
attachment	Attachment
coding	Coding
quantity	Quantity
reference	Reference

QuestionnaireResponseStatusCode

Lifecycle status of the questionnaire response. See http://hl7.org/fhir/ValueSet/questionnaire-answers-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
IN_PROGRESS
COMPLETED
AMENDED
ENTERED_IN_ERROR
STOPPED

Range

Auto-generated from StructureDefinition for Range, last updated 2017-04-19T07:44:43.294+10:00. Set of values bounded by low and high. See http://hl7.org/fhir/StructureDefinition/Range

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
low	SimpleQuantity Low limit
high	SimpleQuantity High limit

Ratio

Auto-generated from StructureDefinition for Ratio, last updated 2017-04-19T07:44:43.294+10:00. A ratio of two Quantity values - a numerator and a denominator. See http://hl7.org/fhir/StructureDefinition/Ratio

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
numerator	Quantity Numerator value
denominator	Quantity Denominator value

Reference

A reference from one resource to another See https://www.hl7.org/fhir/datatypes.html#Reference

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
identifier	Identifier Logical reference, when literal reference is not known
display	String Text alternative for the resource
Union field reference. Literal reference, Relative, internal or absolute URL reference can be only one of the following:
uri	String Absolute URIs are untyped.
fragment	String Fragments (internal references) are untyped, and represented here without the leading '#'.
account_id	ReferenceId Typed relative urls are represented here.
activity_definition_id	ReferenceId
adverse_event_id	ReferenceId
allergy_intolerance_id	ReferenceId
appointment_id	ReferenceId
appointment_response_id	ReferenceId
audit_event_id	ReferenceId
basic_id	ReferenceId
binary_id	ReferenceId
body_site_id	ReferenceId
bundle_id	ReferenceId
capability_statement_id	ReferenceId
care_plan_id	ReferenceId
care_team_id	ReferenceId
charge_item_id	ReferenceId
claim_id	ReferenceId
claim_response_id	ReferenceId
clinical_impression_id	ReferenceId
code_system_id	ReferenceId
communication_id	ReferenceId
communication_request_id	ReferenceId
compartment_definition_id	ReferenceId
composition_id	ReferenceId
concept_map_id	ReferenceId
condition_id	ReferenceId
consent_id	ReferenceId
contract_id	ReferenceId
coverage_id	ReferenceId
data_element_id	ReferenceId
detected_issue_id	ReferenceId
device_id	ReferenceId
device_component_id	ReferenceId
device_metric_id	ReferenceId
device_request_id	ReferenceId
device_use_statement_id	ReferenceId
diagnostic_report_id	ReferenceId
document_manifest_id	ReferenceId
document_reference_id	ReferenceId
eligibility_request_id	ReferenceId
eligibility_response_id	ReferenceId
encounter_id	ReferenceId
endpoint_id	ReferenceId
enrollment_request_id	ReferenceId
enrollment_response_id	ReferenceId
episode_of_care_id	ReferenceId
expansion_profile_id	ReferenceId
explanation_of_benefit_id	ReferenceId
family_member_history_id	ReferenceId
flag_id	ReferenceId
goal_id	ReferenceId
graph_definition_id	ReferenceId
group_id	ReferenceId
guidance_response_id	ReferenceId
healthcare_service_id	ReferenceId
imaging_manifest_id	ReferenceId
imaging_study_id	ReferenceId
immunization_id	ReferenceId
immunization_recommendation_id	ReferenceId
implementation_guide_id	ReferenceId
library_id	ReferenceId
linkage_id	ReferenceId
list_id	ReferenceId
location_id	ReferenceId
measure_id	ReferenceId
measure_report_id	ReferenceId
media_id	ReferenceId
medication_id	ReferenceId
medication_administration_id	ReferenceId
medication_dispense_id	ReferenceId
medication_request_id	ReferenceId
medication_statement_id	ReferenceId
message_definition_id	ReferenceId
message_header_id	ReferenceId
naming_system_id	ReferenceId
nutrition_order_id	ReferenceId
observation_id	ReferenceId
operation_definition_id	ReferenceId
operation_outcome_id	ReferenceId
organization_id	ReferenceId
parameters_id	ReferenceId
patient_id	ReferenceId
payment_notice_id	ReferenceId
payment_reconciliation_id	ReferenceId
person_id	ReferenceId
plan_definition_id	ReferenceId
practitioner_id	ReferenceId
practitioner_role_id	ReferenceId
procedure_id	ReferenceId
procedure_request_id	ReferenceId
process_request_id	ReferenceId
process_response_id	ReferenceId
provenance_id	ReferenceId
questionnaire_id	ReferenceId
questionnaire_response_id	ReferenceId
referral_request_id	ReferenceId
related_person_id	ReferenceId
request_group_id	ReferenceId
research_study_id	ReferenceId
research_subject_id	ReferenceId
risk_assessment_id	ReferenceId
schedule_id	ReferenceId
search_parameter_id	ReferenceId
sequence_id	ReferenceId
service_definition_id	ReferenceId
slot_id	ReferenceId
specimen_id	ReferenceId
structure_definition_id	ReferenceId
structure_map_id	ReferenceId
subscription_id	ReferenceId
substance_id	ReferenceId
supply_delivery_id	ReferenceId
supply_request_id	ReferenceId
task_id	ReferenceId
test_report_id	ReferenceId
test_script_id	ReferenceId
value_set_id	ReferenceId
vision_prescription_id	ReferenceId

ReferenceHandlingPolicyCode

A set of flags that defines how references are supported. See http://hl7.org/fhir/ValueSet/reference-handling-policy

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
LITERAL
LOGICAL
RESOLVES
ENFORCED
LOCAL

ReferenceId

Fields
value	string Primitive value for id
history	Id History version, if present.
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

ReferenceVersionRulesCode

Whether a reference needs to be version specific or version independent, or whether either can be used See http://hl7.org/fhir/ValueSet/reference-version-rules

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
EITHER
INDEPENDENT
SPECIFIC

ReferralRequest

Auto-generated from StructureDefinition for ReferralRequest, last updated 2017-04-19T07:44:43.294+10:00. A request for referral or transfer of care. See http://hl7.org/fhir/StructureDefinition/ReferralRequest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business identifier
definition[]	Reference Instantiates protocol or definition
based_on[]	Reference Request fulfilled by this request
replaces[]	Reference Request(s) replaced by this request
group_identifier	Identifier Composite request this is part of
status	RequestStatusCode draft | active | suspended | cancelled | completed | entered-in-error | unknown
intent	RequestIntentCode proposal | plan | order
type	CodeableConcept Referral/Transition of care request type
priority	RequestPriorityCode Urgency of referral / transfer of care request
service_requested[]	CodeableConcept Actions requested as part of the referral
subject	Reference Patient referred to care or transfer
context	Reference Originating encounter
occurrence	Occurrence
authored_on	DateTime Date of creation/activation
requester	Requester
specialty	CodeableConcept The clinical specialty (discipline) that the referral is requested for
recipient[]	Reference Receiver of referral / transfer of care request
reason_code[]	CodeableConcept Reason for referral / transfer of care request
reason_reference[]	Reference Why is service needed?
description	String A textual description of the referral
supporting_info[]	Reference Additonal information to support referral or transfer of care request
note[]	Annotation Comments made about referral request
relevant_history[]	Reference Key events in history of request

Occurrence

When the service(s) requested in the referral should occur

Fields
Union field occurrence. occurrence can be only one of the following:
date_time	DateTime
period	Period

Requester

Who/what is requesting service

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
agent	Reference Individual making the request
on_behalf_of	Reference Organization agent is acting for

RelatedArtifact

Auto-generated from StructureDefinition for RelatedArtifact, last updated 2017-04-19T07:44:43.294+10:00. Related artifacts for a knowledge resource. See http://hl7.org/fhir/StructureDefinition/RelatedArtifact

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
type	RelatedArtifactTypeCode documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
display	String Brief description of the related artifact
citation	String Bibliographic citation for the artifact
url	Uri Where the artifact can be accessed
document	Attachment What document is being referenced
resource	Reference What resource is being referenced

RelatedArtifactTypeCode

The type of relationship to the related artifact See http://hl7.org/fhir/ValueSet/related-artifact-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DOCUMENTATION
JUSTIFICATION
CITATION
PREDECESSOR
SUCCESSOR
DERIVED_FROM
DEPENDS_ON
COMPOSED_OF

RelatedPerson

Auto-generated from StructureDefinition for RelatedPerson, last updated 2017-04-19T07:44:43.294+10:00. An person that is related to a patient, but who is not a direct target of care. See http://hl7.org/fhir/StructureDefinition/RelatedPerson

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier A human identifier for this person
active	Boolean Whether this related person's record is in active use
patient	Reference The patient this person is related to
relationship	CodeableConcept The nature of the relationship
name[]	HumanName A name associated with the person
telecom[]	ContactPoint A contact detail for the person
gender	AdministrativeGenderCode male | female | other | unknown
birth_date	Date The date on which the related person was born
address[]	Address Address where the related person can be contacted or visited
photo[]	Attachment Image of the person
period	Period Period of time that this relationship is considered valid

RepositoryTypeCode

Type for access of external URI See http://hl7.org/fhir/ValueSet/repository-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DIRECTLINK
OPENAPI
LOGIN
OAUTH
OTHER

RequestGroup

Auto-generated from StructureDefinition for RequestGroup, last updated 2017-04-19T07:44:43.294+10:00. A group of related requests. See http://hl7.org/fhir/StructureDefinition/RequestGroup

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business identifier
definition[]	Reference Instantiates protocol or definition
based_on[]	Reference Fulfills plan, proposal, or order
replaces[]	Reference Request(s) replaced by this request
group_identifier	Identifier Composite request this is part of
status	RequestStatusCode draft | active | suspended | cancelled | completed | entered-in-error | unknown
intent	RequestIntentCode proposal | plan | order
priority	RequestPriorityCode routine | urgent | asap | stat
subject	Reference Who the request group is about
context	Reference Encounter or Episode for the request group
authored_on	DateTime When the request group was authored
author	Reference Device or practitioner that authored the request group
reason	Reason
note[]	Annotation Additional notes about the response
action[]	Action

Action

Proposed actions, if any

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
label	String User-visible label for the action (e.g. 1. or A.)
title	String User-visible title
description	String Short description of the action
text_equivalent	String Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
code[]	CodeableConcept Code representing the meaning of the action or sub-actions
documentation[]	RelatedArtifact Supporting documentation for the intended performer of the action
condition[]	Condition
related_action[]	RelatedAction
timing	TimingType
participant[]	Reference Who should perform the action
type	Coding create | update | remove | fire-event
grouping_behavior	ActionGroupingBehaviorCode visual-group | logical-group | sentence-group
selection_behavior	ActionSelectionBehaviorCode any | all | all-or-none | exactly-one | at-most-one | one-or-more
required_behavior	ActionRequiredBehaviorCode must | could | must-unless-documented
precheck_behavior	ActionPrecheckBehaviorCode yes | no
cardinality_behavior	ActionCardinalityBehaviorCode single | multiple
resource	Reference The target of the action
action[]	Action Sub action

Condition

Whether or not the action is applicable

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
kind	ActionConditionKindCode applicability | start | stop
description	String Natural language description of the condition
language	String Language of the expression
expression	String Boolean-valued expression

RelatedAction

Relationship to another action

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
action_id	Id What action this is related to
relationship	ActionRelationshipTypeCode before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
offset	Offset

Offset

Time offset for the relationship

Fields
Union field offset. offset can be only one of the following:
duration	Duration
range	Range

TimingType

When the action should take place

Fields
Union field timing. timing can be only one of the following:
date_time	DateTime
period	Period
duration	Duration
range	Range
timing_value	Timing

Reason

Reason for the request group

Fields
Union field reason. reason can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

RequestIntentCode

Codes indicating the degree of authority/intentionality associated with a request See http://hl7.org/fhir/ValueSet/request-intent

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PROPOSAL
PLAN
ORDER
ORIGINAL_ORDER
REFLEX_ORDER
FILLER_ORDER
INSTANCE_ORDER
OPTION

RequestPriorityCode

The clinical priority of a diagnostic order. See http://hl7.org/fhir/ValueSet/request-priority

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ROUTINE
URGENT
ASAP
STAT

RequestStatusCode

Codes identifying the stage lifecycle stage of a request See http://hl7.org/fhir/ValueSet/request-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DRAFT
ACTIVE
SUSPENDED
CANCELLED
COMPLETED
ENTERED_IN_ERROR
UNKNOWN

ResearchStudy

Auto-generated from StructureDefinition for ResearchStudy, last updated 2017-04-19T07:44:43.294+10:00. Investigation to increase healthcare-related patient-independent knowledge. See http://hl7.org/fhir/StructureDefinition/ResearchStudy

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business Identifier for study
title	String Name for this study
protocol[]	Reference Steps followed in executing study
part_of[]	Reference Part of larger study
status	ResearchStudyStatusCode draft | in-progress | suspended | stopped | completed | entered-in-error
category[]	CodeableConcept Classifications for the study
focus[]	CodeableConcept Drugs, devices, conditions, etc. under study
contact[]	ContactDetail Contact details for the study
related_artifact[]	RelatedArtifact References and dependencies
keyword[]	CodeableConcept Used to search for the study
jurisdiction[]	CodeableConcept Geographic region(s) for study
description	Markdown What this is study doing
enrollment[]	Reference Inclusion & exclusion criteria
period	Period When the study began and ended
sponsor	Reference Organization responsible for the study
principal_investigator	Reference The individual responsible for the study
site[]	Reference Location involved in study execution
reason_stopped	CodeableConcept Reason for terminating study early
note[]	Annotation Comments made about the event
arm[]	Arm

Arm

Defined path through the study for a subject

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Label for study arm
code	CodeableConcept Categorization of study arm
description	String Short explanation of study path

ResearchStudyStatusCode

Codes that convey the current status of the research study See http://hl7.org/fhir/ValueSet/research-study-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DRAFT
IN_PROGRESS
SUSPENDED
STOPPED
COMPLETED
ENTERED_IN_ERROR

ResearchSubject

Auto-generated from StructureDefinition for ResearchSubject, last updated 2017-04-19T07:44:43.294+10:00. Investigation to increase healthcare-related patient-independent knowledge. See http://hl7.org/fhir/StructureDefinition/ResearchSubject

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Business Identifier for research subject
status	ResearchSubjectStatusCode candidate | enrolled | active | suspended | withdrawn | completed
period	Period Start and end of participation
study	Reference Study subject is part of
individual	Reference Who is part of study
assigned_arm	String What path should be followed
actual_arm	String What path was followed
consent	Reference Agreement to participate in study

ResearchSubjectStatusCode

Indicates the progression of a study subject through a study See http://hl7.org/fhir/ValueSet/research-subject-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CANDIDATE
ENROLLED
ACTIVE
SUSPENDED
WITHDRAWN
COMPLETED

ResourceTypeCode

One of the resource types defined as part of FHIR. See http://hl7.org/fhir/ValueSet/resource-types

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
ACCOUNT
ACTIVITY_DEFINITION
ADVERSE_EVENT
ALLERGY_INTOLERANCE
APPOINTMENT
APPOINTMENT_RESPONSE
AUDIT_EVENT
BASIC
BINARY
BODY_SITE
BUNDLE
CAPABILITY_STATEMENT
CARE_PLAN
CARE_TEAM
CHARGE_ITEM
CLAIM
CLAIM_RESPONSE
CLINICAL_IMPRESSION
CODE_SYSTEM
COMMUNICATION
COMMUNICATION_REQUEST
COMPARTMENT_DEFINITION
COMPOSITION
CONCEPT_MAP
CONDITION
CONSENT
CONTRACT
COVERAGE
DATA_ELEMENT
DETECTED_ISSUE
DEVICE
DEVICE_COMPONENT
DEVICE_METRIC
DEVICE_REQUEST
DEVICE_USE_STATEMENT
DIAGNOSTIC_REPORT
DOCUMENT_MANIFEST
DOCUMENT_REFERENCE
DOMAIN_RESOURCE
ELIGIBILITY_REQUEST
ELIGIBILITY_RESPONSE
ENCOUNTER
ENDPOINT
ENROLLMENT_REQUEST
ENROLLMENT_RESPONSE
EPISODE_OF_CARE
EXPANSION_PROFILE
EXPLANATION_OF_BENEFIT
FAMILY_MEMBER_HISTORY
FLAG
GOAL
GRAPH_DEFINITION
GROUP
GUIDANCE_RESPONSE
HEALTHCARE_SERVICE
IMAGING_MANIFEST
IMAGING_STUDY
IMMUNIZATION
IMMUNIZATION_RECOMMENDATION
IMPLEMENTATION_GUIDE
LIBRARY
LINKAGE
LIST
LOCATION
MEASURE
MEASURE_REPORT
MEDIA
MEDICATION
MEDICATION_ADMINISTRATION
MEDICATION_DISPENSE
MEDICATION_REQUEST
MEDICATION_STATEMENT
MESSAGE_DEFINITION
MESSAGE_HEADER
NAMING_SYSTEM
NUTRITION_ORDER
OBSERVATION
OPERATION_DEFINITION
OPERATION_OUTCOME
ORGANIZATION
PARAMETERS
PATIENT
PAYMENT_NOTICE
PAYMENT_RECONCILIATION
PERSON
PLAN_DEFINITION
PRACTITIONER
PRACTITIONER_ROLE
PROCEDURE
PROCEDURE_REQUEST
PROCESS_REQUEST
PROCESS_RESPONSE
PROVENANCE
QUESTIONNAIRE
QUESTIONNAIRE_RESPONSE
REFERRAL_REQUEST
RELATED_PERSON
REQUEST_GROUP
RESEARCH_STUDY
RESEARCH_SUBJECT
RESOURCE
RISK_ASSESSMENT
SCHEDULE
SEARCH_PARAMETER
SEQUENCE
SERVICE_DEFINITION
SLOT
SPECIMEN
STRUCTURE_DEFINITION
STRUCTURE_MAP
SUBSCRIPTION
SUBSTANCE
SUPPLY_DELIVERY
SUPPLY_REQUEST
TASK
TEST_REPORT
TEST_SCRIPT
VALUE_SET
VISION_PRESCRIPTION

ResourceVersionPolicyCode

How the system supports versioning for a resource. See http://hl7.org/fhir/ValueSet/versioning-policy

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NO_VERSION
VERSIONED
VERSIONED_UPDATE

ResponseTypeCode

The kind of response to a message See http://hl7.org/fhir/ValueSet/response-code

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
OK
TRANSIENT_ERROR
FATAL_ERROR

RestfulCapabilityModeCode

The mode of a RESTful capability statement. See http://hl7.org/fhir/ValueSet/restful-capability-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CLIENT
SERVER

RiskAssessment

Auto-generated from StructureDefinition for RiskAssessment, last updated 2017-04-19T07:44:43.294+10:00. Potential outcomes for a subject with likelihood. See http://hl7.org/fhir/StructureDefinition/RiskAssessment

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Unique identifier for the assessment
based_on	Reference Request fulfilled by this assessment
parent	Reference Part of this occurrence
status	ObservationStatusCode registered | preliminary | final | amended +
method	CodeableConcept Evaluation mechanism
code	CodeableConcept Type of assessment
subject	Reference Who/what does assessment apply to?
context	Reference Where was assessment performed?
occurrence	Occurrence
condition	Reference Condition assessed
performer	Reference Who did assessment?
reason	Reason
basis[]	Reference Information used in assessment
prediction[]	Prediction
mitigation	String How to reduce risk
comment	String Comments on the risk assessment

Occurrence

When was assessment made?

Fields
Union field occurrence. occurrence can be only one of the following:
date_time	DateTime
period	Period

Prediction

Outcome predicted

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
outcome	CodeableConcept Possible outcome for the subject
probability	Probability
qualitative_risk	CodeableConcept Likelihood of specified outcome as a qualitative value
relative_risk	Decimal Relative likelihood
when	When
rationale	String Explanation of prediction

Probability

Likelihood of specified outcome

Fields
Union field probability. probability can be only one of the following:
decimal	Decimal
range	Range

When

Timeframe or age range

Fields
Union field when. when can be only one of the following:
period	Period
range	Range

Reason

Why the assessment was necessary?

Fields
Union field reason. reason can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

SampledData

Auto-generated from StructureDefinition for SampledData, last updated 2017-04-19T07:44:43.294+10:00. A series of measurements taken by a device. See http://hl7.org/fhir/StructureDefinition/SampledData

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
origin	SimpleQuantity Zero value and units
period	Decimal Number of milliseconds between samples
factor	Decimal Multiply data by this before adding to origin
lower_limit	Decimal Lower limit of detection
upper_limit	Decimal Upper limit of detection
dimensions	PositiveInt Number of sample points at each time point
data	String Decimal values with spaces, or "E" | "U" | "L"

Schedule

Auto-generated from StructureDefinition for Schedule, last updated 2017-04-19T07:44:43.294+10:00. A container for slots of time that may be available for booking appointments. See http://hl7.org/fhir/StructureDefinition/Schedule

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Ids for this item
active	Boolean Whether this schedule is in active use
service_category	CodeableConcept A broad categorisation of the service that is to be performed during this appointment
service_type[]	CodeableConcept The specific service that is to be performed during this appointment
specialty[]	CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
actor[]	Reference The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson
planning_horizon	Period The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates
comment	String Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated

SearchComparatorCode

What Search Comparator Codes are supported in search See http://hl7.org/fhir/ValueSet/search-comparator

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
EQ
NE
GT
LT
GE
LE
SA
EB
AP

SearchEntryModeCode

Why an entry is in the result set - whether it's included as a match or because of an _include requirement. See http://hl7.org/fhir/ValueSet/search-entry-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
MATCH
INCLUDE
OUTCOME

SearchModifierCodeCode

A supported modifier for a search parameter. See http://hl7.org/fhir/ValueSet/search-modifier-code

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
MISSING
EXACT
CONTAINS
NOT
TEXT
IN
NOT_IN
BELOW
ABOVE
TYPE

SearchParamTypeCode

Data types allowed to be used for search parameters. See http://hl7.org/fhir/ValueSet/search-param-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NUMBER
DATE
STRING
TOKEN
REFERENCE
COMPOSITE
QUANTITY
URI

SearchParameter

Auto-generated from StructureDefinition for SearchParameter, last updated 2017-04-19T07:44:43.294+10:00. Search Parameter for a resource. See http://hl7.org/fhir/StructureDefinition/SearchParameter

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this search parameter (globally unique)
version	String Business version of the search parameter
name	String Name for this search parameter (computer friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for search parameter (if applicable)
purpose	Markdown Why this search parameter is defined
code	Code Code used in URL
base[]	ResourceTypeCode The resource type(s) this search parameter applies to
type	SearchParamTypeCode number | date | string | token | reference | composite | quantity | uri
derived_from	Uri Original Definition for the search parameter
description	Markdown Natural language description of the search parameter
expression	String FHIRPath expression that extracts the values
xpath	String XPath that extracts the values
xpath_usage	XPathUsageTypeCode normal | phonetic | nearby | distance | other
target[]	ResourceTypeCode Types of resource (if a resource reference)
comparator[]	SearchComparatorCode eq | ne | gt | lt | ge | le | sa | eb | ap
modifier[]	SearchModifierCodeCode missing | exact | contains | not | text | in | not-in | below | above | type
chain[]	String Chained names supported
component[]	Component

Component

For Composite resources to define the parts

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
definition	Reference Defines how the part works
expression	String Subexpression relative to main expression

Sequence

Auto-generated from StructureDefinition for Sequence, last updated 2017-04-19T07:44:43.294+10:00. Information about a biological sequence. See http://hl7.org/fhir/StructureDefinition/Sequence

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Unique ID for this particular sequence. This is a FHIR-defined id
type	SequenceTypeCode aa | dna | rna
coordinate_system	Integer Base number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)
patient	Reference Who and/or what this is about
specimen	Reference Specimen used for sequencing
device	Reference The method for sequencing
performer	Reference Who should be responsible for test result
quantity	Quantity The number of copies of the seqeunce of interest. (RNASeq)
reference_seq	ReferenceSeq
variant[]	Variant
observed_seq	String Sequence that was observed
quality[]	Quality
read_coverage	Integer Average number of reads representing a given nucleotide in the reconstructed sequence
repository[]	Repository
pointer[]	Reference Pointer to next atomic sequence

Quality

An set of value as quality of sequence

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	QualityTypeCode indel | snp | unknown
standard_sequence	CodeableConcept Standard sequence for comparison
start	Integer Start position of the sequence
end	Integer End position of the sequence
score	Quantity Quality score for the comparison
method	CodeableConcept Method to get quality
truth_tp	Decimal True positives from the perspective of the truth data
query_tp	Decimal True positives from the perspective of the query data
truth_fn	Decimal False negatives
query_fp	Decimal False positives
gt_fp	Decimal False positives where the non-REF alleles in the Truth and Query Call Sets match
precision	Decimal Precision of comparison
recall	Decimal Recall of comparison
f_score	Decimal F-score

ReferenceSeq

A sequence used as reference

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
chromosome	CodeableConcept Chromosome containing genetic finding
genome_build	String The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'
reference_seq_id	CodeableConcept Reference identifier
reference_seq_pointer	Reference A Pointer to another Sequence entity as reference sequence
reference_seq_string	String A string to represent reference sequence
strand	Integer Directionality of DNA ( +1/-1)
window_start	Integer Start position of the window on the reference sequence
window_end	Integer End position of the window on the reference sequence

Repository

External repository which contains detailed report related with observedSeq in this resource

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	RepositoryTypeCode directlink | openapi | login | oauth | other
url	Uri URI of the repository
name	String Repository's name
dataset_id	String Id of the dataset that used to call for dataset in repository
variantset_id	String Id of the variantset that used to call for variantset in repository
readset_id	String Id of the read

Variant

Variant in sequence

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
start	Integer Start position of the variant on the reference sequence
end	Integer End position of the variant on the reference sequence
observed_allele	String Allele that was observed
reference_allele	String Allele in the reference sequence
cigar	String Extended CIGAR string for aligning the sequence with reference bases
variant_pointer	Reference Pointer to observed variant information

SequenceTypeCode

Type if a sequence -- DNA, RNA, or amino acid sequence See http://hl7.org/fhir/ValueSet/sequence-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
AA
DNA
RNA

ServiceDefinition

Auto-generated from StructureDefinition for ServiceDefinition, last updated 2017-04-19T07:44:43.294+10:00. A description of decision support service functionality. See http://hl7.org/fhir/StructureDefinition/ServiceDefinition

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this service definition (globally unique)
identifier[]	Identifier Additional identifier for the service definition
version	String Business version of the service definition
name	String Name for this service definition (computer friendly)
title	String Name for this service definition (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
description	Markdown Natural language description of the service definition
purpose	Markdown Why this service definition is defined
usage	String Describes the clinical usage of the module
approval_date	Date When the service definition was approved by publisher
last_review_date	Date When the service definition was last reviewed
effective_period	Period When the service definition is expected to be used
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for service definition (if applicable)
topic[]	CodeableConcept E.g. Education, Treatment, Assessment, etc
contributor[]	Contributor A content contributor
contact[]	ContactDetail Contact details for the publisher
copyright	Markdown Use and/or publishing restrictions
related_artifact[]	RelatedArtifact Additional documentation, citations, etc
trigger[]	TriggerDefinition "when" the module should be invoked
data_requirement[]	DataRequirement What data is used by the module
operation_definition	Reference Operation to invoke

Signature

Auto-generated from StructureDefinition for Signature, last updated 2017-04-19T07:44:43.294+10:00. A digital Signature - XML DigSig, JWT, Graphical image of signature, etc. See http://hl7.org/fhir/StructureDefinition/Signature

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
type[]	Coding Indication of the reason the entity signed the object(s)
when	Instant When the signature was created
who	Who
on_behalf_of	OnBehalfOf
content_type	MimeTypeCode The technical format of the signature
blob	Base64Binary The actual signature content (XML DigSig. JWT, picture, etc.)

OnBehalfOf

The party represented

Fields
Union field on_behalf_of. on_behalf_of can be only one of the following:
uri	Uri
reference	Reference

Who

Who signed

Fields
Union field who. who can be only one of the following:
uri	Uri
reference	Reference

SimpleQuantity

Auto-generated from StructureDefinition for SimpleQuantity, last updated 2017-04-19T07:44:43.294+10:00. A fixed quantity (no comparator). See http://hl7.org/fhir/StructureDefinition/SimpleQuantity

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
value	Decimal Numerical value (with implicit precision)
unit	String Unit representation
system	Uri System that defines coded unit form
code	Code Coded form of the unit

SlicingRulesCode

How slices are interpreted when evaluating an instance. See http://hl7.org/fhir/ValueSet/resource-slicing-rules

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CLOSED
OPEN
OPEN_AT_END

Slot

Auto-generated from StructureDefinition for Slot, last updated 2017-04-19T07:44:43.294+10:00. A slot of time on a schedule that may be available for booking appointments. See http://hl7.org/fhir/StructureDefinition/Slot

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Ids for this item
service_category	CodeableConcept A broad categorisation of the service that is to be performed during this appointment
service_type[]	CodeableConcept The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource
specialty[]	CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
appointment_type	CodeableConcept The style of appointment or patient that may be booked in the slot (not service type)
schedule	Reference The schedule resource that this slot defines an interval of status information
status	SlotStatusCode busy | free | busy-unavailable | busy-tentative | entered-in-error
start	Instant Date/Time that the slot is to begin
end	Instant Date/Time that the slot is to conclude
overbooked	Boolean This slot has already been overbooked, appointments are unlikely to be accepted for this time
comment	String Comments on the slot to describe any extended information. Such as custom constraints on the slot

SlotStatusCode

The free/busy status of the slot. See http://hl7.org/fhir/ValueSet/slotstatus

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
BUSY
FREE
BUSY_UNAVAILABLE
BUSY_TENTATIVE
ENTERED_IN_ERROR

Specimen

Auto-generated from StructureDefinition for Specimen, last updated 2017-04-19T07:44:43.294+10:00. Sample for analysis. See http://hl7.org/fhir/StructureDefinition/Specimen

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier External Identifier
accession_identifier	Identifier Identifier assigned by the lab
status	SpecimenStatusCode available | unavailable | unsatisfactory | entered-in-error
type	CodeableConcept Kind of material that forms the specimen
subject	Reference Where the specimen came from. This may be from the patient(s) or from the environment or a device
received_time	DateTime The time when specimen was received for processing
parent[]	Reference Specimen from which this specimen originated
request[]	Reference Why the specimen was collected
collection	Collection
processing[]	Processing
container[]	Container
note[]	Annotation Comments

Collection

Collection details

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
collector	Reference Who collected the specimen
collected	Collected
quantity	SimpleQuantity The quantity of specimen collected
method	CodeableConcept Technique used to perform collection
body_site	CodeableConcept Anatomical collection site

Collected

Collection time

Fields
Union field collected. collected can be only one of the following:
date_time	DateTime
period	Period

Container

Direct container of specimen (tube/slide, etc.)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Id for the container
description	String Textual description of the container
type	CodeableConcept Kind of container directly associated with specimen
capacity	SimpleQuantity Container volume or size
specimen_quantity	SimpleQuantity Quantity of specimen within container
additive	Additive

Additive

Additive associated with container

Fields
Union field additive. additive can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Processing

Processing and processing step details

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
description	String Textual description of procedure
procedure	CodeableConcept Indicates the treatment step applied to the specimen
additive[]	Reference Material used in the processing step
time	Time

Time

Date and time of specimen processing

Fields
Union field time. time can be only one of the following:
date_time	DateTime
period	Period

SpecimenStatusCode

Codes providing the status/availability of a specimen. See http://hl7.org/fhir/ValueSet/specimen-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
AVAILABLE
UNAVAILABLE
UNSATISFACTORY
ENTERED_IN_ERROR

String

Auto-generated from StructureDefinition for string, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type string. See http://hl7.org/fhir/StructureDefinition/string

Fields
value	string Primitive value for string
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

StructureDefinition

Auto-generated from StructureDefinition for StructureDefinition, last updated 2017-04-19T07:44:43.294+10:00. Structural Definition. See http://hl7.org/fhir/StructureDefinition/StructureDefinition

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this structure definition (globally unique)
identifier[]	Identifier Additional identifier for the structure definition
version	String Business version of the structure definition
name	String Name for this structure definition (computer friendly)
title	String Name for this structure definition (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the structure definition
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for structure definition (if applicable)
purpose	Markdown Why this structure definition is defined
copyright	Markdown Use and/or publishing restrictions
keyword[]	Coding Assist with indexing and finding
fhir_version	Id FHIR Version this StructureDefinition targets
mapping[]	Mapping
kind	StructureDefinitionKindCode primitive-type | complex-type | resource | logical
abstract	Boolean Whether the structure is abstract
context_type	ExtensionContextCode resource | datatype | extension
context[]	String Where the extension can be used in instances
context_invariant[]	String FHIRPath invariants - when the extension can be used
type	FHIRDefinedTypeExtCode Type defined or constrained by this structure
base_definition	Uri Definition that this type is constrained/specialized from
derivation	TypeDerivationRuleCode specialization | constraint - How relates to base definition
snapshot	Snapshot
differential	Differential

Differential

Differential view of the structure

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
element[]	ElementDefinition Definition of elements in the resource (if no StructureDefinition)

Mapping

External specification that the content is mapped to

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identity	Id Internal id when this mapping is used
uri	Uri Identifies what this mapping refers to
name	String Names what this mapping refers to
comment	String Versions, Issues, Scope limitations etc.

Snapshot

Snapshot view of the structure

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
element[]	ElementDefinition Definition of elements in the resource (if no StructureDefinition)

StructureDefinitionKindCode

Defines the type of structure that a definition is describing. See http://hl7.org/fhir/ValueSet/structure-definition-kind

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PRIMITIVE_TYPE
COMPLEX_TYPE
RESOURCE
LOGICAL

StructureMap

Auto-generated from StructureDefinition for StructureMap, last updated 2017-04-19T07:44:43.294+10:00. A Map of relationships between 2 structures that can be used to transform data. See http://hl7.org/fhir/StructureDefinition/StructureMap

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this structure map (globally unique)
identifier[]	Identifier Additional identifier for the structure map
version	String Business version of the structure map
name	String Name for this structure map (computer friendly)
title	String Name for this structure map (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the structure map
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for structure map (if applicable)
purpose	Markdown Why this structure map is defined
copyright	Markdown Use and/or publishing restrictions
structure[]	Structure
import[]	Uri Other maps used by this map (canonical URLs)
group[]	Group

Group

Named sections for reader convenience

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	Id Human-readable label
extends	Id Another group that this group adds rules to
type_mode	StructureMapGroupTypeModeCode none | types | type-and-types
documentation	String Additional description/explaination for group
input[]	Input
rule[]	Rule

Input

Named instance provided when invoking the map

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	Id Name for this instance of data
type	String Type for this instance of data
mode	StructureMapInputModeCode source | target
documentation	String Documentation for this instance of data

Rule

Transform Rule from source to target

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	Id Name of the rule for internal references
source[]	Source
target[]	Target
rule[]	Rule Rules contained in this rule
dependent[]	Dependent
documentation	String Documentation for this instance of data

Dependent

Which other rules to apply in the context of this rule

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	Id Name of a rule or group to apply
variable[]	String Variable to pass to the rule or group

Source

Source inputs to the mapping

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
context	Id Type or variable this rule applies to
min	Integer Specified minimum cardinality
max	String Specified maximum cardinality (number or *)
type	String Rule only applies if source has this type
default_value	DefaultValue
element	String Optional field for this source
list_mode	StructureMapSourceListModeCode first | not_first | last | not_last | only_one
variable	Id Named context for field, if a field is specified
condition	String FHIRPath expression - must be true or the rule does not apply
check	String FHIRPath expression - must be true or the mapping engine throws an error instead of completing

DefaultValue

Default value if no value exists

Fields
Union field default_value. default_value can be only one of the following:
base64_binary	Base64Binary
boolean	Boolean
code	Code
date	Date
date_time	DateTime
decimal	Decimal
id	Id
instant	Instant
integer	Integer
markdown	Markdown
oid	Oid
positive_int	PositiveInt
string_value	String
time	Time
unsigned_int	UnsignedInt
uri	Uri
address	Address
age	Age
annotation	Annotation
attachment	Attachment
codeable_concept	CodeableConcept
coding	Coding
contact_point	ContactPoint
count	Count
distance	Distance
duration	Duration
human_name	HumanName
identifier	Identifier
money	Money
period	Period
quantity	Quantity
range	Range
ratio	Ratio
reference	Reference
sampled_data	SampledData
signature	Signature
timing	Timing
meta	Meta

Target

Content to create because of this mapping rule

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
context	Id Type or variable this rule applies to
context_type	StructureMapContextTypeCode type | variable
element	String Field to create in the context
variable	Id Named context for field, if desired, and a field is specified
list_mode[]	StructureMapTargetListModeCode first | share | last | collate
list_rule_id	Id Internal rule reference for shared list items
transform	StructureMapTransformCode create | copy +
parameter[]	Parameter

Parameter

Parameters to the transform

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
value	Value

Value

Parameter value - variable or literal

Fields
Union field value. value can be only one of the following:
id	Id
string_value	String
boolean	Boolean
integer	Integer
decimal	Decimal

Structure

Structure Definition used by this map

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Canonical URL for structure definition
mode	StructureMapModelModeCode source | queried | target | produced
alias	String Name for type in this map
documentation	String Documentation on use of structure

StructureMapContextTypeCode

How to interpret the context See http://hl7.org/fhir/ValueSet/map-context-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
TYPE
VARIABLE

StructureMapGroupTypeModeCode

If this is the default rule set to apply for the source type, or this combination of types See http://hl7.org/fhir/ValueSet/map-group-type-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NONE
TYPES
TYPE_AND_TYPES

StructureMapInputModeCode

Mode for this instance of data See http://hl7.org/fhir/ValueSet/map-input-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
SOURCE
TARGET

StructureMapModelModeCode

How the referenced structure is used in this mapping See http://hl7.org/fhir/ValueSet/map-model-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
SOURCE
QUERIED
TARGET
PRODUCED

StructureMapSourceListModeCode

If field is a list, how to manage the source See http://hl7.org/fhir/ValueSet/map-source-list-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
FIRST
NOT_FIRST
LAST
NOT_LAST
ONLY_ONE

StructureMapTargetListModeCode

If field is a list, how to manage the production See http://hl7.org/fhir/ValueSet/map-target-list-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
FIRST
SHARE
LAST
COLLATE

StructureMapTransformCode

How data is copied/created See http://hl7.org/fhir/ValueSet/map-transform

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
CREATE
COPY
TRUNCATE
ESCAPE
CAST
APPEND
TRANSLATE
REFERENCE
DATE_OP
UUID
POINTER
EVALUATE
CC
C
QTY
ID
CP

Subscription

Auto-generated from StructureDefinition for Subscription, last updated 2017-04-19T07:44:43.294+10:00. A server push subscription criteria. See http://hl7.org/fhir/StructureDefinition/Subscription

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
status	SubscriptionStatusCode requested | active | error | off
contact[]	ContactPoint Contact details for source (e.g. troubleshooting)
end	Instant When to automatically delete the subscription
reason	String Description of why this subscription was created
criteria	String Rule for server push criteria
error	String Latest error note
channel	Channel
tag[]	Coding A tag to add to matching resources

Channel

The channel on which to report matches to the criteria

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	SubscriptionChannelTypeCode rest-hook | websocket | email | sms | message
endpoint	Uri Where the channel points to
payload	String Mimetype to send, or omit for no payload
header[]	String Usage depends on the channel type

SubscriptionChannelTypeCode

The type of method used to execute a subscription. See http://hl7.org/fhir/ValueSet/subscription-channel-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
REST_HOOK
WEBSOCKET
EMAIL
SMS
MESSAGE

SubscriptionStatusCode

The status of a subscription. See http://hl7.org/fhir/ValueSet/subscription-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
REQUESTED
ACTIVE
ERROR
OFF

Substance

Auto-generated from StructureDefinition for Substance, last updated 2017-04-19T07:44:43.294+10:00. A homogeneous material with a definite composition. See http://hl7.org/fhir/StructureDefinition/Substance

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Unique identifier
status	FHIRSubstanceStatusCode active | inactive | entered-in-error
category[]	CodeableConcept What class/type of substance this is
code	CodeableConcept What substance this is
description	String Textual description of the substance, comments
instance[]	Instance
ingredient[]	Ingredient

Ingredient

Composition information about the substance

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
quantity	Ratio Optional amount (concentration)
substance	SubstanceType

SubstanceType

A component of the substance

Fields
Union field substance. substance can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Instance

If this describes a specific package/container of the substance

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Identifier of the package/container
expiry	DateTime When no longer valid to use
quantity	SimpleQuantity Amount of substance in the package

SupplyDelivery

Auto-generated from StructureDefinition for SupplyDelivery, last updated 2017-04-19T07:44:43.294+10:00. Delivery of bulk Supplies. See http://hl7.org/fhir/StructureDefinition/SupplyDelivery

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier External identifier
based_on[]	Reference Fulfills plan, proposal or order
part_of[]	Reference Part of referenced event
status	SupplyDeliveryStatusCode in-progress | completed | abandoned | entered-in-error
patient	Reference Patient for whom the item is supplied
type	CodeableConcept Category of dispense event
supplied_item	SuppliedItem
occurrence	Occurrence
supplier	Reference Dispenser
destination	Reference Where the Supply was sent
receiver[]	Reference Who collected the Supply

Occurrence

When event occurred

Fields
Union field occurrence. occurrence can be only one of the following:
date_time	DateTime
period	Period
timing	Timing

SuppliedItem

The item that is delivered or supplied

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
quantity	SimpleQuantity Amount dispensed
item	Item

Item

Medication, Substance, or Device supplied

Fields
Union field item. item can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

SupplyDeliveryStatusCode

Status of the supply delivery. See http://hl7.org/fhir/ValueSet/supplydelivery-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
IN_PROGRESS
COMPLETED
ABANDONED
ENTERED_IN_ERROR

SupplyRequest

Auto-generated from StructureDefinition for SupplyRequest, last updated 2017-04-19T07:44:43.294+10:00. Request for a medication, substance or device. See http://hl7.org/fhir/StructureDefinition/SupplyRequest

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier Unique identifier
status	SupplyRequestStatusCode draft | active | suspended +
category	CodeableConcept The kind of supply (central, non-stock, etc.)
priority	RequestPriorityCode routine | urgent | asap | stat
ordered_item	OrderedItem
occurrence	Occurrence
authored_on	DateTime When the request was made
requester	Requester
supplier[]	Reference Who is intended to fulfill the request
reason	Reason
deliver_from	Reference The origin of the supply
deliver_to	Reference The destination of the supply

Occurrence

When the request should be fulfilled

Fields
Union field occurrence. occurrence can be only one of the following:
date_time	DateTime
period	Period
timing	Timing

OrderedItem

The item being requested

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
quantity	Quantity The requested amount of the item indicated
item	Item

Item

Medication, Substance, or Device requested to be supplied

Fields
Union field item. item can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Reason

Why the supply item was requested

Fields
Union field reason. reason can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

Requester

Who/what is requesting service

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
agent	Reference Individual making the request
on_behalf_of	Reference Organization agent is acting for

SupplyRequestStatusCode

Status of the supply request See http://hl7.org/fhir/ValueSet/supplyrequest-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DRAFT
ACTIVE
SUSPENDED
CANCELLED
COMPLETED
ENTERED_IN_ERROR
UNKNOWN

SystemRestfulInteractionCode

Operations supported by REST at the system level. http://hl7.org/fhir/ValueSet/system-restful-interaction

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
TRANSACTION
BATCH
SEARCH_SYSTEM
HISTORY_SYSTEM

SystemVersionProcessingModeCode

How to manage the intersection between a fixed version in a value set, and a fixed version of the system in the expansion profile See http://hl7.org/fhir/ValueSet/system-version-processing-mode

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DEFAULT
CHECK
OVERRIDE

Task

Auto-generated from StructureDefinition for Task, last updated 2017-04-19T07:44:43.294+10:00. A task to be performed. See http://hl7.org/fhir/StructureDefinition/Task

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Task Instance Identifier
definition	Definition
based_on[]	Reference Request fulfilled by this task
group_identifier	Identifier Requisition or grouper id
part_of[]	Reference Composite task
status	TaskStatusCode draft | requested | received | accepted | +
status_reason	CodeableConcept Reason for current status
business_status	CodeableConcept E.g. "Specimen collected", "IV prepped"
intent	RequestIntentCode proposal | plan | order +
priority	RequestPriorityCode normal | urgent | asap | stat
code	CodeableConcept Task Type
description	String Human-readable explanation of task
focus	Reference What task is acting on
for_value	Reference Beneficiary of the Task
context	Reference Healthcare event during which this task originated
execution_period	Period Start and end time of execution
authored_on	DateTime Task Creation Date
last_modified	DateTime Task Last Modified Date
requester	Requester
performer_type[]	CodeableConcept requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
owner	Reference Responsible individual
reason	CodeableConcept Why task is needed
note[]	Annotation Comments made about the task
relevant_history[]	Reference Key events in history of the Task
restriction	Restriction
input[]	Parameter
output[]	Output

Definition

Formal definition of task

Fields
Union field definition. definition can be only one of the following:
uri	Uri
reference	Reference

Output

Information produced as part of task

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept Label for output
value	Value

Value

Result of output

Fields
Union field value. value can be only one of the following:
base64_binary	Base64Binary
boolean	Boolean
code	Code
date	Date
date_time	DateTime
decimal	Decimal
id	Id
instant	Instant
integer	Integer
markdown	Markdown
oid	Oid
positive_int	PositiveInt
string_value	String
time	Time
unsigned_int	UnsignedInt
uri	Uri
address	Address
age	Age
annotation	Annotation
attachment	Attachment
codeable_concept	CodeableConcept
coding	Coding
contact_point	ContactPoint
count	Count
distance	Distance
duration	Duration
human_name	HumanName
identifier	Identifier
money	Money
period	Period
quantity	Quantity
range	Range
ratio	Ratio
reference	Reference
sampled_data	SampledData
signature	Signature
timing	Timing
meta	Meta

Parameter

Information used to perform task

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	CodeableConcept Label for the input
value	Value

Value

Content to use in performing the task

Fields
Union field value. value can be only one of the following:
base64_binary	Base64Binary
boolean	Boolean
code	Code
date	Date
date_time	DateTime
decimal	Decimal
id	Id
instant	Instant
integer	Integer
markdown	Markdown
oid	Oid
positive_int	PositiveInt
string_value	String
time	Time
unsigned_int	UnsignedInt
uri	Uri
address	Address
age	Age
annotation	Annotation
attachment	Attachment
codeable_concept	CodeableConcept
coding	Coding
contact_point	ContactPoint
count	Count
distance	Distance
duration	Duration
human_name	HumanName
identifier	Identifier
money	Money
period	Period
quantity	Quantity
range	Range
ratio	Ratio
reference	Reference
sampled_data	SampledData
signature	Signature
timing	Timing
meta	Meta

Requester

Who is asking for task to be done

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
agent	Reference Individual asking for task
on_behalf_of	Reference Organization individual is acting for

Restriction

Constraints on fulfillment tasks

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
repetitions	PositiveInt How many times to repeat
period	Period When fulfillment sought
recipient[]	Reference For whom is fulfillment sought?

TaskStatusCode

The current status of the task. See http://hl7.org/fhir/ValueSet/task-status

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DRAFT
REQUESTED
RECEIVED
ACCEPTED
REJECTED
READY
CANCELLED
IN_PROGRESS
ON_HOLD
FAILED
COMPLETED
ENTERED_IN_ERROR

TestReport

Auto-generated from StructureDefinition for TestReport, last updated 2017-04-19T07:44:43.294+10:00. Describes the results of a TestScript execution. See http://hl7.org/fhir/StructureDefinition/TestReport

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Identifier External identifier
name	String Informal name of the executed TestScript
status	TestReportStatusCode completed | in-progress | waiting | stopped | entered-in-error
test_script	Reference Reference to the version-specific TestScript that was executed to produce this TestReport
result	TestReportResultCode pass | fail | pending
score	Decimal The final score (percentage of tests passed) resulting from the execution of the TestScript
tester	String Name of the tester producing this report (Organization or individual)
issued	DateTime When the TestScript was executed and this TestReport was generated
participant[]	Participant
setup	Setup
test[]	Test
teardown	Teardown

Participant

A participant in the test execution, either the execution engine, a client, or a server

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	TestReportParticipantTypeCode test-engine | client | server
uri	Uri The uri of the participant. An absolute URL is preferred
display	String The display name of the participant

Setup

The results of the series of required setup operations before the tests were executed

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
action[]	SetupAction

SetupAction

A setup operation or assert that was executed

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
operation	Operation
assert_value	Assert

Assert

The assertion to perform

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
result	TestReportActionResultCode pass | skip | fail | warning | error
message	Markdown A message associated with the result
detail	String A link to further details on the result

Operation

The operation to perform

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
result	TestReportActionResultCode pass | skip | fail | warning | error
message	Markdown A message associated with the result
detail	Uri A link to further details on the result

Teardown

The results of running the series of required clean up steps

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
action[]	TeardownAction

TeardownAction

One or more teardown operations performed

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
operation	Operation The teardown operation performed

Test

A test executed from the test script

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Tracking/logging name of this test
description	String Tracking/reporting short description of the test
action[]	TestAction

TestAction

A test operation or assert that was performed

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
operation	Operation The operation performed
assert_value	Assert The assertion performed

TestReportActionResultCode

The results of executing an action. See http://hl7.org/fhir/ValueSet/report-action-result-codes

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PASS
SKIP
FAIL
WARNING
ERROR

TestReportParticipantTypeCode

The type of participant. See http://hl7.org/fhir/ValueSet/report-participant-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
TEST_ENGINE
CLIENT
SERVER

TestReportResultCode

The reported execution result. See http://hl7.org/fhir/ValueSet/report-result-codes

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
PASS
FAIL
PENDING

TestReportStatusCode

The current status of the test report. See http://hl7.org/fhir/ValueSet/report-status-codes

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
COMPLETED
IN_PROGRESS
WAITING
STOPPED
ENTERED_IN_ERROR

TestScript

Auto-generated from StructureDefinition for TestScript, last updated 2017-04-19T07:44:43.294+10:00. Describes a set of tests. See http://hl7.org/fhir/StructureDefinition/TestScript

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this test script (globally unique)
identifier	Identifier Additional identifier for the test script
version	String Business version of the test script
name	String Name for this test script (computer friendly)
title	String Name for this test script (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the test script
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for test script (if applicable)
purpose	Markdown Why this test script is defined
copyright	Markdown Use and/or publishing restrictions
origin[]	Origin
destination[]	Destination
metadata	Metadata
fixture[]	Fixture
profile[]	Reference Reference of the validation profile
variable[]	Variable
rule[]	Rule
ruleset[]	Ruleset
setup	Setup
test[]	Test
teardown	Teardown

Destination

An abstract server representing a destination or receiver in a message exchange

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
index	Integer The index of the abstract destination server starting at 1
profile	Coding FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor

Fixture

Fixture in the test script - by reference (uri)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
autocreate	Boolean Whether or not to implicitly create the fixture during setup
autodelete	Boolean Whether or not to implicitly delete the fixture during teardown
resource	Reference Reference of the resource

Metadata

Required capability that is assumed to function correctly on the FHIR server being tested

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
link[]	Link
capability[]	Capability

Capability

Capabilities that are assumed to function correctly on the FHIR server being tested

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
required	Boolean Are the capabilities required?
validated	Boolean Are the capabilities validated?
description	String The expected capabilities of the server
origin[]	Integer Which origin server these requirements apply to
destination	Integer Which server these requirements apply to
link[]	Uri Links to the FHIR specification
capabilities	Reference Required Capability Statement

Link

Links to the FHIR specification

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri URL to the specification
description	String Short description

Origin

An abstract server representing a client or sender in a message exchange

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
index	Integer The index of the abstract origin server starting at 1
profile	Coding FHIR-Client | FHIR-SDC-FormFiller

Rule

Assert rule used within the test script

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
resource	Reference Assert rule resource reference
param[]	RuleParam

RuleParam

Rule parameter template

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Parameter name matching external assert rule parameter
value	String Parameter value defined either explicitly or dynamically

Ruleset

Assert ruleset used within the test script

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
resource	Reference Assert ruleset resource reference
rule[]	RulesetRule

RulesetRule

The referenced rule within the ruleset

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
rule_id	Id Id of referenced rule within the ruleset
param[]	RulesetRuleParam

RulesetRuleParam

Ruleset rule parameter template

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Parameter name matching external assert ruleset rule parameter
value	String Parameter value defined either explicitly or dynamically

Setup

A series of required setup operations before tests are executed

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
action[]	SetupAction

SetupAction

A setup operation or assert to perform

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
operation	Operation
assert_value	Assert

Assert

The assertion to perform

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
label	String Tracking/logging assertion label
description	String Tracking/reporting assertion description
direction	AssertionDirectionTypeCode response | request
compare_to_source_id	String Id of the source fixture to be evaluated
compare_to_source_expression	String The fluentpath expression to evaluate against the source fixture
compare_to_source_path	String XPath or JSONPath expression to evaluate against the source fixture
content_type	ContentTypeCode xml | json | ttl | none
expression	String The fluentpath expression to be evaluated
header_field	String HTTP header field name
minimum_id	String Fixture Id of minimum content resource
navigation_links	Boolean Perform validation on navigation links?
operator	AssertionOperatorTypeCode equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval
path	String XPath or JSONPath expression
request_method	TestScriptRequestMethodCodeCode delete | get | options | patch | post | put
request_url	String Request URL comparison value
resource	FHIRDefinedTypeCode Resource type
response	AssertionResponseTypesCode okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable
response_code	String HTTP response code to test
rule	ActionAssertRule
ruleset	ActionAssertRuleset
source_id	Id Fixture Id of source expression or headerField
validate_profile_id	Id Profile Id of validation profile reference
value	String The value to compare to
warning_only	Boolean Will this assert produce a warning only on error?

ActionAssertRule

The reference to a TestScript.rule

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
rule_id	Id Id of the TestScript.rule
param[]	ActionAssertRuleParam

ActionAssertRuleParam

Rule parameter template

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Parameter name matching external assert rule parameter
value	String Parameter value defined either explicitly or dynamically

ActionAssertRuleset

The reference to a TestScript.ruleset

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
ruleset_id	Id Id of the TestScript.ruleset
rule[]	ActionAssertRulesetRule

ActionAssertRulesetRule

The referenced rule within the ruleset

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
rule_id	Id Id of referenced rule within the ruleset
param[]	Param

Param

Rule parameter template

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Parameter name matching external assert ruleset rule parameter
value	String Parameter value defined either explicitly or dynamically

Operation

The setup operation to perform

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
type	Coding The operation code type that will be executed
resource	FHIRDefinedTypeCode Resource type
label	String Tracking/logging operation label
description	String Tracking/reporting operation description
accept	ContentTypeCode xml | json | ttl | none
content_type	ContentTypeCode xml | json | ttl | none
destination	Integer Server responding to the request
encode_request_url	Boolean Whether or not to send the request url in encoded format
origin	Integer Server initiating the request
params	String Explicitly defined path parameters
request_header[]	RequestHeader
request_id	Id Fixture Id of mapped request
response_id	Id Fixture Id of mapped response
source_id	Id Fixture Id of body for PUT and POST requests
target_id	Id Id of fixture used for extracting the [id], [type], and [vid] for GET requests
url	String Request URL

RequestHeader

Each operation can have one or more header elements

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
field	String HTTP header field name
value	String HTTP headerfield value

Teardown

A series of required clean up steps

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
action[]	TeardownAction

TeardownAction

One or more teardown operations to perform

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
operation	Operation The teardown operation to perform

Test

A test in this script

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Tracking/logging name of this test
description	String Tracking/reporting short description of the test
action[]	TestAction

TestAction

A test operation or assert to perform

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
operation	Operation The setup operation to perform
assert_value	Assert The setup assertion to perform

Variable

Placeholder for evaluated elements

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Descriptive name for this variable
default_value	String Default, hard-coded, or user-defined value for this variable
description	String Natural language description of the variable
expression	String The fluentpath expression against the fixture body
header_field	String HTTP header field name for source
hint	String Hint help text for default value to enter
path	String XPath or JSONPath against the fixture body
source_id	Id Fixture Id of source expression or headerField within this variable

TestScriptRequestMethodCodeCode

The allowable request method or HTTP operation codes. See http://hl7.org/fhir/ValueSet/http-operations

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
DELETE
GET
OPTIONS
PATCH
POST
PUT

Time

Auto-generated from StructureDefinition for time, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type time. See http://hl7.org/fhir/StructureDefinition/time

Fields
value_us	int64 Primitive value for time
precision	Precision
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Precision

Enums
PRECISION_UNSPECIFIED
SECOND
MILLISECOND
MICROSECOND

Timing

Auto-generated from StructureDefinition for Timing, last updated 2017-04-19T07:44:43.294+10:00. A timing schedule that specifies an event that may occur multiple times. See http://hl7.org/fhir/StructureDefinition/Timing

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
event[]	DateTime When the event occurs
repeat	Repeat
code	CodeableConcept BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H +

Repeat

When the event is to occur

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
bounds	Bounds
count	Integer Number of times to repeat
count_max	Integer Maximum number of times to repeat
duration	Decimal How long when it happens
duration_max	Decimal How long when it happens (Max)
duration_unit	UnitsOfTimeCode s | min | h | d | wk | mo | a - unit of time (UCUM)
frequency	Integer Event occurs frequency times per period
frequency_max	Integer Event occurs up to frequencyMax times per period
period	Decimal Event occurs frequency times per period
period_max	Decimal Upper limit of period (3-4 hours)
period_unit	UnitsOfTimeCode s | min | h | d | wk | mo | a - unit of time (UCUM)
day_of_week[]	DaysOfWeekCode mon | tue | wed | thu | fri | sat | sun
time_of_day[]	Time Time of day for action
when[]	EventTimingCode Regular life events the event is tied to
offset	UnsignedInt Minutes from event (before or after)

Bounds

Length/Range of lengths, or (Start and/or end) limits

Fields
Union field bounds. bounds can be only one of the following:
duration	Duration
range	Range
period	Period

TriggerDefinition

Auto-generated from StructureDefinition for TriggerDefinition, last updated 2017-04-19T07:44:43.294+10:00. Defines an expected trigger for a module. See http://hl7.org/fhir/StructureDefinition/TriggerDefinition

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
type	TriggerTypeCode named-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended
event_name	String Triggering event name
event_timing	EventTiming
event_data	DataRequirement Triggering data of the event

EventTiming

Timing of the event

Fields
Union field event_timing. event_timing can be only one of the following:
timing	Timing
reference	Reference
date	Date
date_time	DateTime

TriggerTypeCode

The type of trigger See http://hl7.org/fhir/ValueSet/trigger-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NAMED_EVENT
PERIODIC
DATA_ADDED
DATA_MODIFIED
DATA_REMOVED
DATA_ACCESSED
DATA_ACCESS_ENDED

TypeDerivationRuleCode

How a type relates to its baseDefinition. See http://hl7.org/fhir/ValueSet/type-derivation-rule

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
SPECIALIZATION
CONSTRAINT

TypeRestfulInteractionCode

Operations supported by REST at the type or instance level. See http://hl7.org/fhir/ValueSet/type-restful-interaction

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
READ
VREAD
UPDATE
PATCH
DELETE
HISTORY_INSTANCE
HISTORY_TYPE
CREATE
SEARCH_TYPE

UDIEntryTypeCode

Codes to identify how UDI data was entered See http://hl7.org/fhir/ValueSet/udi-entry-type

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
BARCODE
RFID
MANUAL
CARD
SELF_REPORTED
UNKNOWN

UnitsOfTimeCode

A unit of time (units from UCUM). See http://hl7.org/fhir/ValueSet/units-of-time

Fields
value	Value
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
S
MIN
H
D
WK
MO
A

UnknownContentCodeCode

A code that indicates whether an application accepts unknown elements or extensions when reading resources. See http://hl7.org/fhir/ValueSet/unknown-content-code

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NO
EXTENSIONS
ELEMENTS
BOTH

UnsignedInt

Auto-generated from StructureDefinition for unsignedInt, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type unsignedInt. See http://hl7.org/fhir/StructureDefinition/unsignedInt

Fields
value	uint32 Primitive value for unsignedInt
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

Uri

Auto-generated from StructureDefinition for uri, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type uri. See http://hl7.org/fhir/StructureDefinition/uri

Fields
value	string Primitive value for uri
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations

UsageContext

Auto-generated from StructureDefinition for UsageContext, last updated 2017-04-19T07:44:43.294+10:00. Describes the context of use for a conformance or knowledge resource. See http://hl7.org/fhir/StructureDefinition/UsageContext

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
code	Coding Type of context being specified
value	Value

Value

Value that defines the context

Fields
Union field value. value can be only one of the following:
codeable_concept	CodeableConcept
quantity	Quantity
range	Range

UseCode

Complete, proposed, exploratory, other See http://hl7.org/fhir/ValueSet/claim-use

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
COMPLETE
PROPOSED
EXPLORATORY
OTHER

ValueSet

Auto-generated from StructureDefinition for ValueSet, last updated 2017-04-19T07:44:43.294+10:00. A set of codes drawn from one or more code systems. See http://hl7.org/fhir/StructureDefinition/ValueSet

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
url	Uri Logical URI to reference this value set (globally unique)
identifier[]	Identifier Additional identifier for the value set
version	String Business version of the value set
name	String Name for this value set (computer friendly)
title	String Name for this value set (human friendly)
status	PublicationStatusCode draft | active | retired | unknown
experimental	Boolean For testing purposes, not real usage
date	DateTime Date this was last changed
publisher	String Name of the publisher (organization or individual)
contact[]	ContactDetail Contact details for the publisher
description	Markdown Natural language description of the value set
use_context[]	UsageContext Context the content is intended to support
jurisdiction[]	CodeableConcept Intended jurisdiction for value set (if applicable)
immutable	Boolean Indicates whether or not any change to the content logical definition may occur
purpose	Markdown Why this value set is defined
copyright	Markdown Use and/or publishing restrictions
extensible	Boolean Whether this is intended to be used with an extensible binding
compose	Compose
expansion	Expansion

Compose

Definition of the content of the value set (CLD)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
locked_date	Date Fixed date for version-less references (transitive)
inactive	Boolean Whether inactive codes are in the value set
include[]	ConceptSet
exclude[]	ConceptSet Explicitly exclude codes from a code system or other value sets

ConceptSet

Include one or more codes from a code system or other value set(s)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
system	Uri The system the codes come from
version	String Specific version of the code system referred to
concept[]	ConceptReference
filter[]	Filter
value_set[]	Uri Select only contents included in this value set

ConceptReference

A concept defined in the system

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
code	Code Code or expression from system
display	String Text to display for this code for this value set in this valueset
designation[]	Designation

Designation

Additional representations for this concept

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
language	LanguageCode Human language of the designation
use	Coding Details how this designation would be used
value	String The text value for this designation

Filter

Select codes/concepts by their properties (including relationships)

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
property	Code A property defined by the code system
op	FilterOperatorCode = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
value	Code Code from the system, or regex criteria, or boolean value for exists

Expansion

Used when the value set is "expanded"

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier	Uri Uniquely identifies this expansion
timestamp	DateTime Time ValueSet expansion happened
total	Integer Total number of codes in the expansion
offset	Integer Offset at which this resource starts
parameter[]	Parameter
contains[]	Contains

Contains

Codes in the value set

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
system	Uri System value for the code
abstract	Boolean If user cannot select this entry
inactive	Boolean If concept is inactive in the code system
version	String Version in which this code/display is defined
code	Code Code - if blank, this is not a selectable code
display	String User display for the concept
designation[]	Designation Additional representations for this item
contains[]	Contains Codes contained under this entry

Parameter

Parameter that controlled the expansion process

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
name	String Name as assigned by the server
value	Value

Value

Value of the named parameter

Fields
Union field value. value can be only one of the following:
string_value	String
boolean	Boolean
integer	Integer
decimal	Decimal
uri	Uri
code	Code

VisionBaseCode

A coded concept listing the base codes. See http://hl7.org/fhir/ValueSet/vision-base-codes

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
UP
DOWN
IN
OUT

VisionEyesCode

A coded concept listing the eye codes. See http://hl7.org/fhir/ValueSet/vision-eye-codes

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
RIGHT
LEFT

VisionPrescription

Auto-generated from StructureDefinition for VisionPrescription, last updated 2017-04-19T07:44:43.294+10:00. Prescription for vision correction products for a patient. See http://hl7.org/fhir/StructureDefinition/VisionPrescription

Fields
id	Id Logical id of this artifact
meta	Meta Metadata about the resource
implicit_rules	Uri A set of rules under which this content was created
language	LanguageCode Language of the resource content
text	Narrative Text summary of the resource, for human interpretation
contained[]	ContainedResource Contained, inline Resources
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
identifier[]	Identifier Business identifier
status	FinancialResourceStatusCode active | cancelled | draft | entered-in-error
patient	Reference Who prescription is for
encounter	Reference Created during encounter / admission / stay
date_written	DateTime When prescription was authorized
prescriber	Reference Who authorizes the vision product
reason	Reason
dispense[]	Dispense

Dispense

Vision supply authorization

Fields
id	String xml:id (or equivalent in JSON)
extension[]	Extension Additional Content defined by implementations
modifier_extension[]	Extension Extensions that cannot be ignored
product	CodeableConcept Product to be supplied
eye	VisionEyesCode right | left
sphere	Decimal Lens sphere
cylinder	Decimal Lens cylinder
axis	Integer Lens axis
prism	Decimal Lens prism
base	VisionBaseCode up | down | in | out
add	Decimal Lens add
power	Decimal Contact lens power
back_curve	Decimal Contact lens back curvature
diameter	Decimal Contact lens diameter
duration	SimpleQuantity Lens wear duration
color	String Color required
brand	String Brand required
note[]	Annotation Notes for coatings

Reason

Reason or indication for writing the prescription

Fields
Union field reason. reason can be only one of the following:
codeable_concept	CodeableConcept
reference	Reference

XPathUsageTypeCode

How a search parameter relates to the set of elements returned by evaluating its xpath query. See http://hl7.org/fhir/ValueSet/search-xpath-usage

Fields
value	Value
id	String
extension[]	Extension

Value

Enums
INVALID_UNINITIALIZED
NORMAL
PHONETIC
NEARBY
DISTANCE
OTHER

Xhtml

Auto-generated from StructureDefinition for xhtml, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type xhtml. See http://hl7.org/fhir/StructureDefinition/xhtml

Fields
value	string Actual xhtml
id	String xml:id (or equivalent in JSON)