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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Account number |
status |
active | inactive | entered-in-error |
type |
E.g. patient, expense, depreciation |
name |
Human-readable label |
subject |
What is account tied to? |
period |
Transaction window |
active |
Time window that transactions may be posted to this account |
balance |
How much is in account? |
coverage[] |
|
owner |
Who is responsible? |
description |
Explanation of purpose/use |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
coverage |
The party(s) that are responsible for covering the payment of this account |
priority |
The priority of the coverage in the context of this account |
Guarantor
Responsible for the account
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
party |
Responsible entity |
on_hold |
Credit or other hold applied |
period |
Guarrantee account during |
AccountStatusCode
Indicates whether the account is available to be used. See http://hl7.org/fhir/ValueSet/account-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this activity definition (globally unique) |
identifier[] |
Additional identifier for the activity definition |
version |
Business version of the activity definition |
name |
Name for this activity definition (computer friendly) |
title |
Name for this activity definition (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
description |
Natural language description of the activity definition |
purpose |
Why this activity definition is defined |
usage |
Describes the clinical usage of the asset |
approval_date |
When the activity definition was approved by publisher |
last_review_date |
When the activity definition was last reviewed |
effective_period |
When the activity definition is expected to be used |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for activity definition (if applicable) |
topic[] |
E.g. Education, Treatment, Assessment, etc |
contributor[] |
A content contributor |
contact[] |
Contact details for the publisher |
copyright |
Use and/or publishing restrictions |
related_artifact[] |
Additional documentation, citations, etc |
library[] |
Logic used by the asset |
kind |
Kind of resource |
code |
Detail type of activity |
timing |
|
location |
Where it should happen |
participant[] |
|
product |
|
quantity |
How much is administered/consumed/supplied |
dosage[] |
Detailed dosage instructions |
body_site[] |
What part of body to perform on |
transform |
Transform to apply the template |
dynamic_value[] |
|
DynamicValue
Dynamic aspects of the definition
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
description |
Natural language description of the dynamic value |
path |
The path to the element to be set dynamically |
language |
Language of the expression |
expression |
An expression that provides the dynamic value for the customization |
Participant
Who should participate in the action
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
patient | practitioner | related-person |
role |
E.g. Nurse, Surgeon, Parent, etc |
Product
What's administered/supplied
| Fields | |
|---|---|
Union field
|
|
reference |
|
codeable_concept |
|
TimingType
When activity is to occur
| Fields | |
|---|---|
Union field
|
|
timing_value |
|
date_time |
|
period |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
use |
home | work | temp | old - purpose of this address |
type |
postal | physical | both |
text |
Text representation of the address |
line[] |
Street name, number, direction & P.O. Box etc. |
city |
Name of city, town etc. |
district |
District name (aka county) |
state |
Sub-unit of country (abbreviations ok) |
postal_code |
Postal code for area |
country |
Country (e.g. can be ISO 3166 2 or 3 letter code) |
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 |
|
id |
xml:id (or equivalent in JSON) |
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 |
|
id |
xml:id (or equivalent in JSON) |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Business identifier for the event |
category |
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 |
actual | potential |
subject |
Subject or group impacted by event |
date |
When the event occurred |
reaction[] |
Adverse Reaction Events linked to exposure to substance |
location |
Location where adverse event occurred |
seriousness |
Mild | Moderate | Severe |
outcome |
resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown |
recorder |
Who recorded the adverse event |
event_participant |
Who was involved in the adverse event or the potential adverse event |
description |
Description of the adverse event |
suspect_entity[] |
|
subject_medical_history[] |
AdverseEvent.subjectMedicalHistory |
reference_document[] |
AdverseEvent.referenceDocument |
study[] |
AdverseEvent.study |
SuspectEntity
The suspected agent causing the adverse event
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
instance |
Refers to the specific entity that caused the adverse event |
causality |
causality1 | causality2 |
causality_assessment |
assess1 | assess2 |
causality_product_relatedness |
AdverseEvent.suspectEntity.causalityProductRelatedness |
causality_method |
method1 | method2 |
causality_author |
AdverseEvent.suspectEntity.causalityAuthor |
causality_result |
result1 | result2 |
AdverseEventCategoryCode
Overall categorization of the event, e.g. real or potential See http://hl7.org/fhir/ValueSet/adverse-event-category
| Fields | |
|---|---|
value |
|
id |
|
extension[] |
|
Value
| Enums | |
|---|---|
INVALID_UNINITIALIZED |
|
AE |
|
PAE |
|
AdverseEventCausalityCode
TODO See http://hl7.org/fhir/ValueSet/adverse-event-causality
| Fields | |
|---|---|
value |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
value |
Numerical value (with implicit precision) |
comparator |
< | <= | >= | > - how to understand the value |
unit |
Unit representation |
system |
System that defines coded unit form |
code |
Coded form of the unit |
AggregationModeCode
How resource references can be aggregated. See http://hl7.org/fhir/ValueSet/resource-aggregation-mode
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External ids for this item |
clinical_status |
active | inactive | resolved |
verification_status |
unconfirmed | confirmed | refuted | entered-in-error |
type |
allergy | intolerance - Underlying mechanism (if known) |
category[] |
food | medication | environment | biologic |
criticality |
low | high | unable-to-assess |
code |
Code that identifies the allergy or intolerance |
patient |
Who the sensitivity is for |
onset |
|
asserted_date |
Date record was believed accurate |
recorder |
Who recorded the sensitivity |
asserter |
Source of the information about the allergy |
last_occurrence |
Date(/time) of last known occurrence of a reaction |
note[] |
Additional text not captured in other fields |
reaction[] |
|
Onset
When allergy or intolerance was identified
| Fields | |
|---|---|
Union field
|
|
date_time |
|
age |
|
period |
|
range |
|
string_value |
|
Reaction
Adverse Reaction Events linked to exposure to substance
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
substance |
Specific substance or pharmaceutical product considered to be responsible for event |
manifestation[] |
Clinical symptoms/signs associated with the Event |
description |
Description of the event as a whole |
onset |
Date(/time) when manifestations showed |
severity |
mild | moderate | severe (of event as a whole) |
exposure_route |
How the subject was exposed to the substance |
note[] |
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
author |
|
time |
When the annotation was made |
text |
The annotation - text content |
Author
Individual responsible for the annotation
| Fields | |
|---|---|
Union field
|
|
reference |
|
string_value |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Ids for this item |
status |
proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error |
service_category |
A broad categorisation of the service that is to be performed during this appointment |
service_type[] |
The specific service that is to be performed during this appointment |
specialty[] |
The specialty of a practitioner that would be required to perform the service requested in this appointment |
appointment_type |
The style of appointment or patient that has been booked in the slot (not service type) |
reason[] |
Reason this appointment is scheduled |
indication[] |
Reason the appointment is to takes place (resource) |
priority |
Used to make informed decisions if needing to re-prioritize |
description |
Shown on a subject line in a meeting request, or appointment list |
supporting_information[] |
Additional information to support the appointment |
start |
When appointment is to take place |
end |
When appointment is to conclude |
minutes_duration |
Can be less than start/end (e.g. estimate) |
slot[] |
The slots that this appointment is filling |
created |
The date that this appointment was initially created |
comment |
Additional comments |
incoming_referral[] |
The ReferralRequest provided as information to allocate to the Encounter |
participant[] |
|
requested_period[] |
Potential date/time interval(s) requested to allocate the appointment within |
Participant
Participants involved in appointment
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type[] |
Role of participant in the appointment |
actor |
Person, Location/HealthcareService or Device |
required |
required | optional | information-only |
status |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Ids for this item |
appointment |
Appointment this response relates to |
start |
Time from appointment, or requested new start time |
end |
Time from appointment, or requested new end time |
participant_type[] |
Role of participant in the appointment |
actor |
Person, Location/HealthcareService or Device |
participant_status |
accepted | declined | tentative | in-process | completed | needs-action | entered-in-error |
comment |
Additional comments |
AppointmentStatusCode
The free/busy status of an appointment. See http://hl7.org/fhir/ValueSet/appointmentstatus
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
content_type |
Mime type of the content, with charset etc. |
language |
Human language of the content (BCP-47) |
data |
Data inline, base64ed |
url |
Uri where the data can be found |
size |
Number of bytes of content (if url provided) |
hash |
Hash of the data (sha-1, base64ed) |
title |
Label to display in place of the data |
creation |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Type/identifier of event |
subtype[] |
More specific type/id for the event |
action |
Type of action performed during the event |
recorded |
Time when the event occurred on source |
outcome |
Whether the event succeeded or failed |
outcome_desc |
Description of the event outcome |
purpose_of_event[] |
The purposeOfUse of the event |
agent[] |
|
source |
|
entity[] |
|
Agent
Actor involved in the event
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
role[] |
Agent role in the event |
reference |
Direct reference to resource |
user_id |
Unique identifier for the user |
alt_id |
Alternative User id e.g. authentication |
name |
Human-meaningful name for the agent |
requestor |
Whether user is initiator |
location |
Where |
policy[] |
Policy that authorized event |
media |
Type of media |
network |
|
purpose_of_use[] |
Reason given for this user |
Network
Logical network location for application activity
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
address |
Identifier for the network access point of the user device |
type |
The type of network access point |
Entity
Data or objects used
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Specific instance of object |
reference |
Specific instance of resource |
type |
Type of entity involved |
role |
What role the entity played |
lifecycle |
Life-cycle stage for the entity |
security_label[] |
Security labels on the entity |
name |
Descriptor for entity |
description |
Descriptive text |
query |
Query parameters |
detail[] |
|
Detail
Additional Information about the entity
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Name of the property |
value |
Property value |
Source
Audit Event Reporter
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
site |
Logical source location within the enterprise |
identifier |
The identity of source detecting the event |
type[] |
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Primitive value for base64Binary |
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business identifier |
code |
Kind of Resource |
subject |
Identifies the focus of this resource |
created |
When created |
author |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
content_type |
MimeType of the binary content |
security_context |
Access Control Management |
content |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Bodysite identifier |
active |
Whether this body site record is in active use |
code |
Named anatomical location |
qualifier[] |
Modification to location code |
description |
Anatomical location description |
image[] |
Attached images |
patient |
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 |
Primitive value for boolean |
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
identifier |
Persistent identifier for the bundle |
type |
document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection |
total |
If search, the total number of matches |
link[] |
|
entry[] |
|
signature |
Digital Signature |
Entry
Entry in the bundle - will have a resource, or information
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
link[] |
Links related to this entry |
full_url |
Absolute URL for resource (server address, or UUID/OID) |
resource |
A resource in the bundle |
search |
|
request |
|
response |
|
Request
Transaction Related Information
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
method |
GET | POST | PUT | DELETE |
url |
URL for HTTP equivalent of this entry |
if_none_match |
For managing cache currency |
if_modified_since |
For managing update contention |
if_match |
For managing update contention |
if_none_exist |
For conditional creates |
Response
Transaction Related Information
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
status |
Status response code (text optional) |
location |
The location, if the operation returns a location |
etag |
The etag for the resource (if relevant) |
last_modified |
Server's date time modified |
outcome |
OperationOutcome with hints and warnings (for batch/transaction) |
Search
Search related information
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
mode |
match | include | outcome - why this is in the result set |
score |
Search ranking (between 0 and 1) |
Link
Links related to this Bundle
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
relation |
See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
url |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this capability statement (globally unique) |
version |
Business version of the capability statement |
name |
Name for this capability statement (computer friendly) |
title |
Name for this capability statement (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the capability statement |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for capability statement (if applicable) |
purpose |
Why this capability statement is defined |
copyright |
Use and/or publishing restrictions |
kind |
instance | capability | requirements |
instantiates[] |
Canonical URL of another capability statement this implements |
software |
|
implementation |
|
fhir_version |
FHIR Version the system uses |
accept_unknown |
no | extensions | elements | both |
format[] |
formats supported (xml | json | ttl | mime type) |
patch_format[] |
Patch formats supported |
implementation_guide[] |
Implementation guides supported |
profile[] |
Profiles for use cases supported |
rest[] |
|
messaging[] |
|
document[] |
|
Document
Document definition
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
mode |
producer | consumer |
documentation |
Description of document support |
profile |
Constraint on a resource used in the document |
Implementation
If this describes a specific instance
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
description |
Describes this specific instance |
url |
Base URL for the installation |
Messaging
If messaging is supported
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
endpoint[] |
|
reliable_cache |
Reliable Message Cache Length (min) |
documentation |
Messaging interface behavior details |
supported_message[] |
|
event[] |
|
Endpoint
Where messages should be sent
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
protocol |
http | ftp | mllp + |
address |
Network address or identifier of the end-point |
Event
Declare support for this event
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Event type |
category |
Consequence | Currency | Notification |
mode |
sender | receiver |
focus |
Resource that's focus of message |
request |
Profile that describes the request |
response |
Profile that describes the response |
documentation |
Endpoint-specific event documentation |
SupportedMessage
Messages supported by this system
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
mode |
sender | receiver |
definition |
Message supported by this system |
Rest
If the endpoint is a RESTful one
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
mode |
client | server |
documentation |
General description of implementation |
security |
|
resource[] |
|
interaction[] |
|
search_param[] |
Search parameters for searching all resources |
operation[] |
|
compartment[] |
Compartments served/used by system |
Operation
Definition of an operation or a custom query
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name by which the operation/query is invoked |
definition |
The defined operation/query |
Resource
Resource served on the REST interface
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
A resource type that is supported |
profile |
Base System profile for all uses of resource |
documentation |
Additional information about the use of the resource type |
interaction[] |
|
versioning |
no-version | versioned | versioned-update |
read_history |
Whether vRead can return past versions |
update_create |
If update can commit to a new identity |
conditional_create |
If allows/uses conditional create |
conditional_read |
not-supported | modified-since | not-match | full-support |
conditional_update |
If allows/uses conditional update |
conditional_delete |
not-supported | single | multiple - how conditional delete is supported |
reference_policy[] |
literal | logical | resolves | enforced | local |
search_include[] |
_include values supported by the server |
search_rev_include[] |
_revinclude values supported by the server |
search_param[] |
|
ResourceInteraction
What operations are supported?
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
read | vread | update | patch | delete | history-instance | history-type | create | search-type |
documentation |
Anything special about operation behavior |
SearchParam
Search parameters supported by implementation
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name of search parameter |
definition |
Source of definition for parameter |
type |
number | date | string | token | reference | composite | quantity | uri |
documentation |
Server-specific usage |
Security
Information about security of implementation
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
cors |
Adds CORS Headers (http://enable-cors.org/) |
service[] |
OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates |
description |
General description of how security works |
certificate[] |
|
Certificate
Certificates associated with security profiles
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Mime type for certificates |
blob |
Actual certificate |
SystemInteraction
What operations are supported?
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
transaction | batch | search-system | history-system |
documentation |
Anything special about operation behavior |
Software
Software that is covered by this capability statement
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
A name the software is known by |
version |
Version covered by this statement |
release_date |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Ids for this plan |
definition[] |
Protocol or definition |
based_on[] |
Fulfills care plan |
replaces[] |
CarePlan replaced by this CarePlan |
part_of[] |
Part of referenced CarePlan |
status |
draft | active | suspended | completed | entered-in-error | cancelled | unknown |
intent |
proposal | plan | order | option |
category[] |
Type of plan |
title |
Human-friendly name for the CarePlan |
description |
Summary of nature of plan |
subject |
Who care plan is for |
context |
Created in context of |
period |
Time period plan covers |
author[] |
Who is responsible for contents of the plan |
care_team[] |
Who's involved in plan? |
addresses[] |
Health issues this plan addresses |
supporting_info[] |
Information considered as part of plan |
goal[] |
Desired outcome of plan |
activity[] |
|
note[] |
Comments about the plan |
Activity
Action to occur as part of plan
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
outcome_codeable_concept[] |
Results of the activity |
outcome_reference[] |
Appointment, Encounter, Procedure, etc. |
progress[] |
Comments about the activity status/progress |
reference |
Activity details defined in specific resource |
detail |
|
Detail
In-line definition of activity
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
category |
diet | drug | encounter | observation | procedure | supply | other |
definition |
Protocol or definition |
code |
Detail type of activity |
reason_code[] |
Why activity should be done or why activity was prohibited |
reason_reference[] |
Condition triggering need for activity |
goal[] |
Goals this activity relates to |
status |
not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown |
status_reason |
Reason for current status |
prohibited |
Do NOT do |
scheduled |
|
location |
Where it should happen |
performer[] |
Who will be responsible? |
product |
|
daily_amount |
How to consume/day? |
quantity |
How much to administer/supply/consume |
description |
Extra info describing activity to perform |
Product
What is to be administered/supplied
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Scheduled
When activity is to occur
| Fields | |
|---|---|
Union field
|
|
timing |
|
period |
|
string_value |
|
CarePlanActivityStatusCode
Indicates where the activity is at in its overall life cycle. See http://hl7.org/fhir/ValueSet/care-plan-activity-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Ids for this team |
status |
proposed | active | suspended | inactive | entered-in-error |
category[] |
Type of team |
name |
Name of the team, such as crisis assessment team |
subject |
Who care team is for |
context |
Encounter or episode associated with CareTeam |
period |
Time period team covers |
participant[] |
|
reason_code[] |
Why the care team exists |
reason_reference[] |
Why the care team exists |
managing_organization[] |
Organization responsible for the care team |
note[] |
Comments made about the CareTeam |
Participant
Members of the team
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
role |
Type of involvement |
member |
Who is involved |
on_behalf_of |
Organization of the practitioner |
period |
Time period of participant |
CareTeamStatusCode
Indicates the status of the care team. See http://hl7.org/fhir/ValueSet/care-team-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Business Identifier for item |
definition[] |
Defining information about the code of this charge item |
status |
planned | billable | not-billable | aborted | billed | entered-in-error | unknown |
part_of[] |
Part of referenced ChargeItem |
code |
A code that identifies the charge, like a billing code |
subject |
Individual service was done for/to |
context |
Encounter / Episode associated with event |
occurrence |
|
participant[] |
|
performing_organization |
Organization providing the charged sevice |
requesting_organization |
Organization requesting the charged service |
quantity |
Quantity of which the charge item has been serviced |
bodysite[] |
Anatomical location, if relevant |
factor_override |
Factor overriding the associated rules |
price_override |
Price overriding the associated rules |
override_reason |
Reason for overriding the list price/factor |
enterer |
Individual who was entering |
entered_date |
Date the charge item was entered |
reason[] |
Why was the charged service rendered? |
service[] |
Which rendered service is being charged? |
account[] |
Account to place this charge |
note[] |
Comments made about the ChargeItem |
supporting_information[] |
Further information supporting the this charge |
Occurrence
When the charged service was applied
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
timing |
|
Participant
Who performed charged service
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
role |
What type of performance was done |
actor |
Individual who was performing |
ChargeItemStatusCode
Codes identifying the stage lifecycle stage of a ChargeItem See http://hl7.org/fhir/ValueSet/chargeitem-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Claim number |
status |
active | cancelled | draft | entered-in-error |
type |
Type or discipline |
sub_type[] |
Finer grained claim type information |
use |
complete | proposed | exploratory | other |
patient |
The subject of the Products and Services |
billable_period |
Period for charge submission |
created |
Creation date |
enterer |
Author |
insurer |
Target |
provider |
Responsible provider |
organization |
Responsible organization |
priority |
Desired processing priority |
funds_reserve |
Funds requested to be reserved |
related[] |
|
prescription |
Prescription authorizing services or products |
original_prescription |
Original prescription if superceded by fulfiller |
payee |
|
referral |
Treatment Referral |
facility |
Servicing Facility |
care_team[] |
|
information[] |
|
diagnosis[] |
|
procedure[] |
|
insurance[] |
|
accident |
|
employment_impacted |
Period unable to work |
hospitalization |
Period in hospital |
item[] |
|
total |
Total claim cost |
Accident
Details about an accident
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
date |
When the accident occurred see information codes see information codes |
type |
The nature of the accident |
location |
|
Location
Accident Place
| Fields | |
|---|---|
Union field
|
|
address |
|
reference |
|
CareTeam
Members of the care team
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Number to covey order of careTeam |
provider |
Provider individual or organization |
responsible |
Billing provider |
role |
Role on the team |
qualification |
Type, classification or Specialization |
Diagnosis
List of Diagnosis
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Number to covey order of diagnosis |
diagnosis |
|
type[] |
Timing or nature of the diagnosis |
package_code |
Package billing code |
DiagnosisType
Patient's diagnosis
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Insurance
Insurance or medical plan
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Service instance identifier |
focal |
Is the focal Coverage |
coverage |
Insurance information |
business_arrangement |
Business agreement |
pre_auth_ref[] |
Pre-Authorization/Determination Reference |
claim_response |
Adjudication results |
Item
Goods and Services
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Service instance |
care_team_link_id[] |
Applicable careTeam members |
diagnosis_link_id[] |
Applicable diagnoses |
procedure_link_id[] |
Applicable procedures |
information_link_id[] |
Applicable exception and supporting information |
revenue |
Revenue or cost center code |
category |
Type of service or product |
service |
Billing Code |
modifier[] |
Service/Product billing modifiers |
program_code[] |
Program specific reason for item inclusion |
serviced |
|
location |
|
quantity |
Count of Products or Services |
unit_price |
Fee, charge or cost per point |
factor |
Price scaling factor |
net |
Total item cost |
udi[] |
Unique Device Identifier |
body_site |
Service Location |
sub_site[] |
Service Sub-location |
encounter[] |
Encounters related to this billed item |
detail[] |
|
Detail
Additional items
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Service instance |
revenue |
Revenue or cost center code |
category |
Type of service or product |
service |
Billing Code |
modifier[] |
Service/Product billing modifiers |
program_code[] |
Program specific reason for item inclusion |
quantity |
Count of Products or Services |
unit_price |
Fee, charge or cost per point |
factor |
Price scaling factor |
net |
Total additional item cost |
udi[] |
Unique Device Identifier |
sub_detail[] |
|
SubDetail
Additional items
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Service instance |
revenue |
Revenue or cost center code |
category |
Type of service or product |
service |
Billing Code |
modifier[] |
Service/Product billing modifiers |
program_code[] |
Program specific reason for item inclusion |
quantity |
Count of Products or Services |
unit_price |
Fee, charge or cost per point |
factor |
Price scaling factor |
net |
Net additional item cost |
udi[] |
Unique Device Identifier |
Location
Place of service
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
address |
|
reference |
|
Serviced
Date or dates of Service
| Fields | |
|---|---|
Union field
|
|
date |
|
period |
|
Payee
Party to be paid any benefits payable
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Type of party: Subscriber, Provider, other |
resource_type |
organization | patient | practitioner | relatedperson |
party |
Party to receive the payable |
Procedure
Procedures performed
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Procedure sequence for reference |
date |
When the procedure was performed |
procedure |
|
ProcedureType
Patient's list of procedures performed
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
RelatedClaim
Related Claims which may be revelant to processing this claimn
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
claim |
Reference to the related claim |
relationship |
How the reference claim is related |
reference |
Related file or case reference |
SpecialCondition
Exceptions, special considerations, the condition, situation, prior or concurrent issues
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Information instance identifier |
category |
General class of information |
code |
Type of information |
timing |
|
value |
|
reason |
Reason associated with the information |
TimingType
When it occurred
| Fields | |
|---|---|
Union field
|
|
date |
|
period |
|
Value
Additional Data or supporting information
| Fields | |
|---|---|
Union field
|
|
string_value |
|
quantity |
|
attachment |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Response number |
status |
active | cancelled | draft | entered-in-error |
patient |
The subject of the Products and Services |
created |
Creation date |
insurer |
Insurance issuing organization |
request_provider |
Responsible practitioner |
request_organization |
Responsible organization |
request |
Id of resource triggering adjudication |
outcome |
complete | error | partial |
disposition |
Disposition Message |
payee_type |
Party to be paid any benefits payable |
item[] |
|
add_item[] |
|
error[] |
|
total_cost |
Total Cost of service from the Claim |
unalloc_deductable |
Unallocated deductible |
total_benefit |
Total benefit payable for the Claim |
payment |
|
reserved |
Funds reserved status |
form |
Printed Form Identifier |
process_note[] |
|
communication_request[] |
Request for additional information |
insurance[] |
|
AddedItem
Insurer added line items
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence_link_id[] |
Service instances |
revenue |
Revenue or cost center code |
category |
Type of service or product |
service |
Group, Service or Product |
modifier[] |
Service/Product billing modifiers |
fee |
Professional fee or Product charge |
note_number[] |
List of note numbers which apply |
adjudication[] |
Added items adjudication |
detail[] |
|
AddedItemsDetail
Added items details
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
revenue |
Revenue or cost center code |
category |
Type of service or product |
service |
Service or Product |
modifier[] |
Service/Product billing modifiers |
fee |
Professional fee or Product charge |
note_number[] |
List of note numbers which apply |
adjudication[] |
Added items detail adjudication |
Error
Processing errors
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence_link_id |
Item sequence number |
detail_sequence_link_id |
Detail sequence number |
subdetail_sequence_link_id |
Subdetail sequence number |
code |
Error code detailing processing issues |
Insurance
Insurance or medical plan
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Service instance identifier |
focal |
Is the focal Coverage |
coverage |
Insurance information |
business_arrangement |
Business agreement |
pre_auth_ref[] |
Pre-Authorization/Determination Reference |
claim_response |
Adjudication results |
Item
Line items
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence_link_id |
Service instance |
note_number[] |
List of note numbers which apply |
adjudication[] |
|
detail[] |
|
Adjudication
Adjudication details
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
category |
Adjudication category such as co-pay, eligible, benefit, etc. |
reason |
Explanation of Adjudication outcome |
amount |
Monetary amount |
value |
Non-monetary value |
ItemDetail
Detail line items
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence_link_id |
Service instance |
note_number[] |
List of note numbers which apply |
adjudication[] |
Detail level adjudication details |
sub_detail[] |
|
SubDetail
Subdetail line items
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence_link_id |
Service instance |
note_number[] |
List of note numbers which apply |
adjudication[] |
Subdetail level adjudication details |
Note
Processing notes
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
number |
Sequence Number for this note |
type |
display | print | printoper |
text |
Note explanatory text |
language |
Language if different from the resource |
Payment
Payment details, if paid
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Partial or Complete |
adjustment |
Payment adjustment for non-Claim issues |
adjustment_reason |
Explanation for the non-claim adjustment |
date |
Expected data of Payment |
amount |
Payable amount after adjustment |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business identifier |
status |
draft | completed | entered-in-error |
code |
Kind of assessment performed |
description |
Why/how the assessment was performed |
subject |
Patient or group assessed |
context |
Encounter or Episode created from |
effective |
|
date |
When the assessment was documented |
assessor |
The clinician performing the assessment |
previous |
Reference to last assessment |
problem[] |
Relevant impressions of patient state |
investigation[] |
|
protocol[] |
Clinical Protocol followed |
summary |
Summary of the assessment |
finding[] |
|
prognosis_codeable_concept[] |
Estimate of likely outcome |
prognosis_reference[] |
RiskAssessment expressing likely outcome |
action[] |
Action taken as part of assessment procedure |
note[] |
Comments made about the ClinicalImpression |
Effective
Time of assessment
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
Finding
Possible or likely findings and diagnoses
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
item |
|
basis |
Which investigations support finding |
Item
What was found
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Investigation
One or more sets of investigations (signs, symptions, etc.)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
A name/code for the set |
item[] |
Record of a specific investigation |
ClinicalImpressionStatusCode
The workflow state of a clinical impression. See http://hl7.org/fhir/ValueSet/clinical-impression-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
Primitive value for code |
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this code system (globally unique) (Coding.system) |
identifier |
Additional identifier for the code system |
version |
Business version of the code system (Coding.version) |
name |
Name for this code system (computer friendly) |
title |
Name for this code system (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the code system |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for code system (if applicable) |
purpose |
Why this code system is defined |
copyright |
Use and/or publishing restrictions |
case_sensitive |
If code comparison is case sensitive |
value_set |
Canonical URL for value set with entire code system |
hierarchy_meaning |
grouped-by | is-a | part-of | classified-with |
compositional |
If code system defines a post-composition grammar |
version_needed |
If definitions are not stable |
content |
not-present | example | fragment | complete |
count |
Total concepts in the code system |
filter[] |
|
property[] |
|
concept[] |
|
ConceptDefinition
Concepts in the code system
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Code that identifies concept |
display |
Text to display to the user |
definition |
Formal definition |
designation[] |
|
property[] |
|
concept[] |
Child Concepts (is-a/contains/categorizes) |
ConceptProperty
Property value for the concept
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Reference to CodeSystem.property.code |
value |
|
Value
Value of the property for this concept
| Fields | |
|---|---|
Union field
|
|
code |
|
coding |
|
string_value |
|
integer |
|
boolean |
|
date_time |
|
Designation
Additional representations for the concept
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
language |
Human language of the designation |
use |
Details how this designation would be used |
value |
The text value for this designation |
Filter
Filter that can be used in a value set
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Code that identifies the filter |
description |
How or why the filter is used |
operator[] |
Operators that can be used with filter |
value |
What to use for the value |
Property
Additional information supplied about each concept
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Identifies the property on the concepts, and when referred to in operations |
uri |
Formal identifier for the property |
description |
Why the property is defined, and/or what it conveys |
type |
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 |
|
id |
|
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 |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
coding[] |
Code defined by a terminology system |
text |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
system |
Identity of the terminology system |
version |
Version of the system - if relevant |
code |
Symbol in syntax defined by the system |
display |
Representation defined by the system |
user_selected |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Unique identifier |
definition[] |
Instantiates protocol or definition |
based_on[] |
Request fulfilled by this communication |
part_of[] |
Part of this action |
status |
preparation | in-progress | suspended | aborted | completed | entered-in-error |
not_done |
Communication did not occur |
not_done_reason |
Why communication did not occur |
category[] |
Message category |
medium[] |
A channel of communication |
subject |
Focus of message |
recipient[] |
Message recipient |
topic[] |
Focal resources |
context |
Encounter or episode leading to message |
sent |
When sent |
received |
When received |
sender |
Message sender |
reason_code[] |
Indication for message |
reason_reference[] |
Why was communication done? |
payload[] |
|
note[] |
Comments made about the communication |
Payload
Message payload
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
content |
|
Content
Message part content
| Fields | |
|---|---|
Union field
|
|
string_value |
|
attachment |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Unique identifier |
based_on[] |
Fulfills plan or proposal |
replaces[] |
Request(s) replaced by this request |
group_identifier |
Composite request this is part of |
status |
draft | active | suspended | cancelled | completed | entered-in-error | unknown |
category[] |
Message category |
priority |
Message urgency |
medium[] |
A channel of communication |
subject |
Focus of message |
recipient[] |
Message recipient |
topic[] |
Focal resources |
context |
Encounter or episode leading to message |
payload[] |
|
occurrence |
|
authored_on |
When request transitioned to being actionable |
sender |
Message sender |
requester |
|
reason_code[] |
Why is communication needed? |
reason_reference[] |
Why is communication needed? |
note[] |
Comments made about communication request |
Occurrence
When scheduled
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
Payload
Message payload
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
content |
|
Content
Message part content
| Fields | |
|---|---|
Union field
|
|
string_value |
|
attachment |
|
reference |
|
Requester
Who/what is requesting service
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
agent |
Individual making the request |
on_behalf_of |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this compartment definition (globally unique) |
name |
Name for this compartment definition (computer friendly) |
title |
Name for this compartment definition (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the compartment definition |
purpose |
Why this compartment definition is defined |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for compartment definition (if applicable) |
code |
Patient | Encounter | RelatedPerson | Practitioner | Device |
search |
Whether the search syntax is supported |
resource[] |
|
Resource
How a resource is related to the compartment
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Name of resource type |
param[] |
Search Parameter Name, or chained parameters |
documentation |
Additional documentation about the resource and compartment |
CompartmentTypeCode
Which compartment a compartment definition describes See http://hl7.org/fhir/ValueSet/compartment-type
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Logical identifier of composition (version-independent) |
status |
preliminary | final | amended | entered-in-error |
type |
Kind of composition (LOINC if possible) |
class_value |
Categorization of Composition |
subject |
Who and/or what the composition is about |
encounter |
Context of the Composition |
date |
Composition editing time |
author[] |
Who and/or what authored the composition |
title |
Human Readable name/title |
confidentiality |
As defined by affinity domain |
attester[] |
|
custodian |
Organization which maintains the composition |
relates_to[] |
|
event[] |
|
section[] |
|
Attester
Attests to accuracy of composition
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
mode[] |
personal | professional | legal | official |
time |
When the composition was attested |
party |
Who attested the composition |
Event
The clinical service(s) being documented
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code[] |
Code(s) that apply to the event being documented |
period |
The period covered by the documentation |
detail[] |
The event(s) being documented |
RelatesTo
Relationships to other compositions/documents
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
replaces | transforms | signs | appends |
target |
|
Target
Target of the relationship
| Fields | |
|---|---|
Union field
|
|
identifier |
|
reference |
|
Section
Composition is broken into sections
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
title |
Label for section (e.g. for ToC) |
code |
Classification of section (recommended) |
text |
Text summary of the section, for human interpretation |
mode |
working | snapshot | changes |
ordered_by |
Order of section entries |
entry[] |
A reference to data that supports this section |
empty_reason |
Why the section is empty |
section[] |
Nested Section |
CompositionAttestationModeCode
The way in which a person authenticated a composition. See http://hl7.org/fhir/ValueSet/composition-attestation-mode
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this concept map (globally unique) |
identifier |
Additional identifier for the concept map |
version |
Business version of the concept map |
name |
Name for this concept map (computer friendly) |
title |
Name for this concept map (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the concept map |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for concept map (if applicable) |
purpose |
Why this concept map is defined |
copyright |
Use and/or publishing restrictions |
source |
|
target |
|
group[] |
|
Group
Same source and target systems
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
source |
Code System (if value set crosses code systems) |
source_version |
Specific version of the code system |
target |
System of the target (if necessary) |
target_version |
Specific version of the code system |
element[] |
|
unmapped |
|
SourceElement
Mappings for a concept from the source set
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Identifies element being mapped |
display |
Display for the code |
target[] |
|
TargetElement
Concept in target system for element
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Code that identifies the target element |
display |
Display for the code |
equivalence |
relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint |
comment |
Description of status/issues in mapping |
depends_on[] |
|
product[] |
Other concepts that this mapping also produces |
OtherElement
Other elements required for this mapping (from context)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
property |
Reference to property mapping depends on |
system |
Code System (if necessary) |
code |
Value of the referenced element |
display |
Display for the code |
Unmapped
When no match in the mappings
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
mode |
provided | fixed | other-map |
code |
Fixed code when mode = fixed |
display |
Display for the code |
url |
Canonical URL for other concept map |
Source
Identifies the source of the concepts which are being mapped
| Fields | |
|---|---|
Union field
|
|
uri |
|
reference |
|
Target
Provides context to the mappings
| Fields | |
|---|---|
Union field
|
|
uri |
|
reference |
|
ConceptMapEquivalenceCode
The degree of equivalence between concepts. See http://hl7.org/fhir/ValueSet/concept-map-equivalence
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Ids for this condition |
clinical_status |
active | recurrence | inactive | remission | resolved |
verification_status |
provisional | differential | confirmed | refuted | entered-in-error | unknown |
category[] |
problem-list-item | encounter-diagnosis |
severity |
Subjective severity of condition |
code |
Identification of the condition, problem or diagnosis |
body_site[] |
Anatomical location, if relevant |
subject |
Who has the condition? |
context |
Encounter or episode when condition first asserted |
onset |
|
abatement |
|
asserted_date |
Date record was believed accurate |
asserter |
Person who asserts this condition |
stage |
|
evidence[] |
|
note[] |
Additional information about the Condition |
Abatement
If/when in resolution/remission
| Fields | |
|---|---|
Union field
|
|
date_time |
|
age |
|
boolean |
|
period |
|
range |
|
string_value |
|
Evidence
Supporting evidence
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code[] |
Manifestation/symptom |
detail[] |
Supporting information found elsewhere |
Onset
Estimated or actual date, date-time, or age
| Fields | |
|---|---|
Union field
|
|
date_time |
|
age |
|
period |
|
range |
|
string_value |
|
Stage
Stage/grade, usually assessed formally
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
summary |
Simple summary (disease specific) |
assessment[] |
Formal record of assessment |
ConditionClinicalStatusCodesCode
Preferred value set for Condition Clinical Status. See http://hl7.org/fhir/ValueSet/condition-clinical
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Identifier for this record (external references) |
status |
draft | proposed | active | rejected | inactive | entered-in-error |
category[] |
Classification of the consent statement - for indexing/retrieval |
patient |
Who the consent applies to |
period |
Period that this consent applies |
date_time |
When this Consent was created or indexed |
consenting_party[] |
Who is agreeing to the policy and exceptions |
actor[] |
|
action[] |
Actions controlled by this consent |
organization[] |
Custodian of the consent |
source |
|
policy[] |
|
policy_rule |
Policy that this consents to |
security_label[] |
Security Labels that define affected resources |
purpose[] |
Context of activities for which the agreement is made |
data_period |
Timeframe for data controlled by this consent |
data[] |
|
except[] |
|
Actor
Who|what controlled by this consent (or group, by role)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
role |
How the actor is involved |
reference |
Resource for the actor (or group, by role) |
Data
Data controlled by this consent
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
meaning |
instance | related | dependents | authoredby |
reference |
The actual data reference |
Except
Additional rule - addition or removal of permissions
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
deny | permit |
period |
Timeframe for this exception |
actor[] |
|
action[] |
Actions controlled by this exception |
security_label[] |
Security Labels that define affected resources |
purpose[] |
Context of activities covered by this exception |
class_value[] |
e.g. Resource Type, Profile, or CDA etc |
code[] |
e.g. LOINC or SNOMED CT code, etc in the content |
data_period |
Timeframe for data controlled by this exception |
data[] |
|
ExceptActor
Who|what controlled by this exception (or group, by role)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
role |
How the actor is involved |
reference |
Resource for the actor (or group, by role) |
ExceptData
Data controlled by this exception
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
meaning |
instance | related | dependents | authoredby |
reference |
The actual data reference |
Policy
Policies covered by this consent
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
authority |
Enforcement source for policy |
uri |
Specific policy covered by this consent |
Source
Source from which this consent is taken
| Fields | |
|---|---|
Union field
|
|
attachment |
|
identifier |
|
reference |
|
ConsentDataMeaningCode
How a resource reference is interpreted when testing consent restrictions See http://hl7.org/fhir/ValueSet/consent-data-meaning
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
name |
Name of an individual to contact |
telecom[] |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
system |
phone | fax | email | pager | url | sms | other |
value |
The actual contact point details |
use |
home | work | temp | old | mobile - purpose of this contact point |
rank |
Specify preferred order of use (1 = highest) |
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 |
|
id |
xml:id (or equivalent in JSON) |
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 |
|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
Value
Primitive value for code
| Enums | |
|---|---|
INVALID_UNINITIALIZED |
|
HOME |
|
WORK |
|
TEMP |
|
OLD |
|
MOBILE |
|
ContainedResource
| Fields | |
|---|---|
Union field
|
|
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 |
|
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 |
|
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 |
|
ContentTypeCode
The content or mime type. See http://hl7.org/fhir/ValueSet/content-type
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Contract number |
status |
amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated |
issued |
When this Contract was issued |
applies |
Effective time |
subject[] |
Contract Target Entity |
topic[] |
Context of the Contract |
authority[] |
Authority under which this Contract has standing |
domain[] |
Domain in which this Contract applies |
type |
Type or form |
sub_type[] |
Subtype within the context of type |
action[] |
Action stipulated by this Contract |
action_reason[] |
Rationale for the stiplulated action |
decision_type |
Decision by Grantor |
content_derivative |
Content derived from the basal information |
security_label[] |
Security Labels that define affected resources |
agent[] |
|
signer[] |
|
valued_item[] |
|
term[] |
|
binding |
|
friendly[] |
|
legal[] |
|
rule[] |
|
Agent
Entity being ascribed responsibility
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
actor |
Contract Agent Type |
role[] |
Role type of the agent |
Binding
Binding Contract
| Fields | |
|---|---|
Union field
|
|
attachment |
|
reference |
|
ComputableLanguage
Computable Contract Language
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
content |
|
Content
Computable Contract Rules
| Fields | |
|---|---|
Union field
|
|
attachment |
|
reference |
|
FriendlyLanguage
Contract Friendly Language
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
content |
|
Content
Easily comprehended representation of this Contract
| Fields | |
|---|---|
Union field
|
|
attachment |
|
reference |
|
LegalLanguage
Contract Legal Language
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
content |
|
Content
Contract Legal Text
| Fields | |
|---|---|
Union field
|
|
attachment |
|
reference |
|
Signatory
Contract Signatory
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Contract Signatory Role |
party |
Contract Signatory Party |
signature[] |
Contract Documentation Signature |
Term
Contract Term List
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Contract Term Number |
issued |
Contract Term Issue Date Time |
applies |
Contract Term Effective Time |
type |
Contract Term Type or Form |
sub_type |
Contract Term Type specific classification |
topic[] |
Context of the Contract term |
action[] |
Contract Term Activity |
action_reason[] |
Purpose for the Contract Term Action |
security_label[] |
Security Labels that define affected terms |
agent[] |
|
text |
Human readable Contract term text |
valued_item[] |
|
group[] |
Nested Contract Term Group |
TermAgent
Contract Term Agent List
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
actor |
Contract Term Agent Subject |
role[] |
Type of the Contract Term Agent |
TermValuedItem
Contract Term Valued Item List
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
entity |
|
identifier |
Contract Term Valued Item Number |
effective_time |
Contract Term Valued Item Effective Tiem |
quantity |
Contract Term Valued Item Count |
unit_price |
Contract Term Valued Item fee, charge, or cost |
factor |
Contract Term Valued Item Price Scaling Factor |
points |
Contract Term Valued Item Difficulty Scaling Factor |
net |
Total Contract Term Valued Item Value |
Entity
Contract Term Valued Item Type
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
ValuedItem
Contract Valued Item List
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
entity |
|
identifier |
Contract Valued Item Number |
effective_time |
Contract Valued Item Effective Tiem |
quantity |
Count of Contract Valued Items |
unit_price |
Contract Valued Item fee, charge, or cost |
factor |
Contract Valued Item Price Scaling Factor |
points |
Contract Valued Item Difficulty Scaling Factor |
net |
Total Contract Valued Item Value |
Entity
Contract Valued Item Type
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
ContractResourceStatusCode
This value set contract specific codes for status. See http://hl7.org/fhir/ValueSet/contract-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
type |
author | editor | reviewer | endorser |
name |
Who contributed the content |
contact[] |
Contact details of the contributor |
ContributorTypeCode
The type of contributor See http://hl7.org/fhir/ValueSet/contributor-type
| Fields | |
|---|---|
value |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
value |
Numerical value (with implicit precision) |
comparator |
< | <= | >= | > - how to understand the value |
unit |
Unit representation |
system |
System that defines coded unit form |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
The primary coverage ID |
status |
active | cancelled | draft | entered-in-error |
type |
Type of coverage such as medical or accident |
policy_holder |
Owner of the policy |
subscriber |
Subscriber to the policy |
subscriber_id |
ID assigned to the Subscriber |
beneficiary |
Plan Beneficiary |
relationship |
Beneficiary relationship to the Subscriber |
period |
Coverage start and end dates |
payor[] |
Identifier for the plan or agreement issuer |
grouping |
|
dependent |
Dependent number |
sequence |
The plan instance or sequence counter |
order |
Relative order of the coverage |
network |
Insurer network |
contract[] |
Contract details |
Group
Additional coverage classifications
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
group |
An identifier for the group |
group_display |
Display text for an identifier for the group |
sub_group |
An identifier for the subsection of the group |
sub_group_display |
Display text for the subsection of the group |
plan |
An identifier for the plan |
plan_display |
Display text for the plan |
sub_plan |
An identifier for the subsection of the plan |
sub_plan_display |
Display text for the subsection of the plan |
class_value |
An identifier for the class |
class_display |
Display text for the class |
sub_class |
An identifier for the subsection of the class |
sub_class_display |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this data element (globally unique) |
identifier[] |
Additional identifier for the data element |
version |
Business version of the data element |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
name |
Name for this data element (computer friendly) |
title |
Name for this data element (human friendly) |
contact[] |
Contact details for the publisher |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for data element (if applicable) |
copyright |
Use and/or publishing restrictions |
stringency |
comparable | fully-specified | equivalent | convertable | scaleable | flexible |
mapping[] |
|
element[] |
Definition of element |
Mapping
External specification mapped to
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identity |
Internal id when this mapping is used |
uri |
Identifies what this mapping refers to |
name |
Names what this mapping refers to |
comment |
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 |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
type |
The type of the required data |
profile[] |
The profile of the required data |
must_support[] |
Indicates that specific structure elements are referenced by the knowledge module |
code_filter[] |
|
date_filter[] |
|
CodeFilter
What codes are expected
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
path |
The code-valued attribute of the filter |
value_set |
|
value_code[] |
What code is expected |
value_coding[] |
What Coding is expected |
value_codeable_concept[] |
What CodeableConcept is expected |
ValueSet
Valueset for the filter
| Fields | |
|---|---|
Union field
|
|
string_value |
|
reference |
|
DateFilter
What dates/date ranges are expected
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
path |
The date-valued attribute of the filter |
value |
|
Value
The value of the filter, as a Period, DateTime, or Duration value
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
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 |
Primitive value for date |
timezone |
|
precision |
|
id |
xml:id (or equivalent in JSON) |
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 |
Primitive value for dateTime |
timezone |
|
precision |
|
id |
xml:id (or equivalent in JSON) |
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 |
|
id |
xml:id (or equivalent in JSON) |
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 |
Primitive value for decimal |
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Unique id for the detected issue |
status |
registered | preliminary | final | amended + |
category |
Issue Category, e.g. drug-drug, duplicate therapy, etc. |
severity |
high | moderate | low |
patient |
Associated patient |
date |
When identified |
author |
The provider or device that identified the issue |
implicated[] |
Problem resource |
detail |
Description and context |
reference |
Authority for issue |
mitigation[] |
|
Mitigation
Step taken to address
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
action |
What mitigation? |
date |
Date committed |
author |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Instance identifier |
udi |
|
status |
active | inactive | entered-in-error | unknown |
type |
What kind of device this is |
lot_number |
Lot number of manufacture |
manufacturer |
Name of device manufacturer |
manufacture_date |
Date when the device was made |
expiration_date |
Date and time of expiry of this device (if applicable) |
model |
Model id assigned by the manufacturer |
version |
Version number (i.e. software) |
patient |
Patient to whom Device is affixed |
owner |
Organization responsible for device |
contact[] |
Details for human/organization for support |
location |
Where the resource is found |
url |
Network address to contact device |
note[] |
Device notes and comments |
safety[] |
Safety Characteristics of Device |
Udi
Unique Device Identifier (UDI) Barcode string
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
device_identifier |
Mandatory fixed portion of UDI |
name |
Device Name as appears on UDI label |
jurisdiction |
Regional UDI authority |
carrier_hrf |
UDI Human Readable Barcode String |
carrier_aidc |
UDI Machine Readable Barcode String |
issuer |
UDI Issuing Organization |
entry_type |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Instance id assigned by the software stack |
type |
What kind of component it is |
last_system_change |
Recent system change timestamp |
source |
Top-level device resource link |
parent |
Parent resource link |
operational_status[] |
Current operational status of the component, for example On, Off or Standby |
parameter_group |
Current supported parameter group |
measurement_principle |
other | chemical | electrical | impedance | nuclear | optical | thermal | biological | mechanical | acoustical | manual+ |
production_specification[] |
|
language_code |
Language code for the human-readable text strings produced by the device |
ProductionSpecification
Specification details such as Component Revisions, or Serial Numbers
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
spec_type |
Type or kind of production specification, for example serial number or software revision |
component_id |
Internal component unique identification |
production_spec |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Unique identifier of this DeviceMetric |
type |
Identity of metric, for example Heart Rate or PEEP Setting |
unit |
Unit of Measure for the Metric |
source |
Describes the link to the source Device |
parent |
Describes the link to the parent DeviceComponent |
operational_status |
on | off | standby | entered-in-error |
color |
black | red | green | yellow | blue | magenta | cyan | white |
category |
measurement | setting | calculation | unspecified |
measurement_period |
Describes the measurement repetition time |
calibration[] |
|
Calibration
Describes the calibrations that have been performed or that are required to be performed
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
unspecified | offset | gain | two-point |
state |
not-calibrated | calibration-required | calibrated | unspecified |
time |
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Request identifier |
definition[] |
Protocol or definition |
based_on[] |
What request fulfills |
prior_request[] |
What request replaces |
group_identifier |
Identifier of composite request |
status |
draft | active | suspended | completed | entered-in-error | cancelled |
intent |
proposal | plan | original-order | encoded | reflex-order |
priority |
Indicates how quickly the request should be addressed with respect to other requests |
code |
|
subject |
Focus of request |
context |
Encounter or Episode motivating request |
occurrence |
|
authored_on |
When recorded |
requester |
|
performer_type |
Fille role |
performer |
Requested Filler |
reason_code[] |
Coded Reason for request |
reason_reference[] |
Linked Reason for request |
supporting_info[] |
Additional clinical information |
note[] |
Notes or comments |
relevant_history[] |
Request provenance |
Code
Device requested
| Fields | |
|---|---|
Union field
|
|
reference |
|
codeable_concept |
|
Occurrence
Desired time or schedule for use
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
timing |
|
Requester
Who/what is requesting diagnostics
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
agent |
Individual making the request |
on_behalf_of |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External identifier for this record |
status |
active | completed | entered-in-error + |
subject |
Patient using device |
when_used |
Period device was used |
timing |
|
recorded_on |
When statement was recorded |
source |
Who made the statement |
device |
Reference to device used |
indication[] |
Why device was used |
body_site |
Target body site |
note[] |
Addition details (comments, instructions) |
TimingType
How often the device was used
| Fields | |
|---|---|
Union field
|
|
timing_value |
|
period |
|
date_time |
|
DeviceUseStatementStatusCode
A coded concept indicating the current status of a the Device Usage See http://hl7.org/fhir/ValueSet/device-statement-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business identifier for report |
based_on[] |
What was requested |
status |
registered | partial | preliminary | final + |
category |
Service category |
code |
Name/Code for this diagnostic report |
subject |
The subject of the report - usually, but not always, the patient |
context |
Health care event when test ordered |
effective |
|
issued |
DateTime this version was released |
performer[] |
|
specimen[] |
Specimens this report is based on |
result[] |
Observations - simple, or complex nested groups |
imaging_study[] |
Reference to full details of imaging associated with the diagnostic report |
image[] |
|
conclusion |
Clinical Interpretation of test results |
coded_diagnosis[] |
Codes for the conclusion |
presented_form[] |
Entire report as issued |
Effective
Clinically relevant time/time-period for report
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
Image
Key images associated with this report
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
comment |
Comment about the image (e.g. explanation) |
link |
Reference to the image source |
Performer
Participants in producing the report
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
role |
Type of performer |
actor |
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
value |
Numerical value (with implicit precision) |
comparator |
< | <= | >= | > - how to understand the value |
unit |
Unit representation |
system |
System that defines coded unit form |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
master_identifier |
Unique Identifier for the set of documents |
identifier[] |
Other identifiers for the manifest |
status |
current | superseded | entered-in-error |
type |
Kind of document set |
subject |
The subject of the set of documents |
created |
When this document manifest created |
author[] |
Who and/or what authored the manifest |
recipient[] |
Intended to get notified about this set of documents |
source |
The source system/application/software |
description |
Human-readable description (title) |
content[] |
|
related[] |
|
Content
The items included
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
p |
|
P
Contents of this set of documents
| Fields | |
|---|---|
Union field
|
|
attachment |
|
reference |
|
Related
Related things
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Identifiers of things that are related |
ref |
Related Resource |
DocumentModeCode
Whether the application produces or consumes documents. See http://hl7.org/fhir/ValueSet/document-mode
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
master_identifier |
Master Version Specific Identifier |
identifier[] |
Other identifiers for the document |
status |
current | superseded | entered-in-error |
doc_status |
preliminary | final | appended | amended | entered-in-error |
type |
Kind of document (LOINC if possible) |
class_value |
Categorization of document |
subject |
Who/what is the subject of the document |
created |
Document creation time |
indexed |
When this document reference was created |
author[] |
Who and/or what authored the document |
authenticator |
Who/what authenticated the document |
custodian |
Organization which maintains the document |
relates_to[] |
|
description |
Human-readable description (title) |
security_label[] |
Document security-tags |
content[] |
|
context |
|
Content
Document referenced
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
attachment |
Where to access the document |
format |
Format/content rules for the document |
Context
Clinical context of document
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
encounter |
Context of the document content |
event[] |
Main clinical acts documented |
period |
Time of service that is being documented |
facility_type |
Kind of facility where patient was seen |
practice_setting |
Additional details about where the content was created (e.g. clinical specialty) |
source_patient_info |
Patient demographics from source |
related[] |
|
Related
Related identifiers or resources
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Identifier of related objects or events |
ref |
Related Resource |
RelatesTo
Relationships to other documents
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
replaces | transforms | signs | appends |
target |
Target of the relationship |
DocumentReferenceStatusCode
The status of the document reference. See http://hl7.org/fhir/ValueSet/document-reference-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
sequence |
The order of the dosage instructions |
text |
Free text dosage instructions e.g. SIG |
additional_instruction[] |
Supplemental instruction - e.g. "with meals" |
patient_instruction |
Patient or consumer oriented instructions |
timing |
When medication should be administered |
as_needed |
|
site |
Body site to administer to |
route |
How drug should enter body |
method |
Technique for administering medication |
dose |
|
max_dose_per_period |
Upper limit on medication per unit of time |
max_dose_per_administration |
Upper limit on medication per administration |
max_dose_per_lifetime |
Upper limit on medication per lifetime of the patient |
rate |
|
AsNeeded
Take "as needed" (for x)
| Fields | |
|---|---|
Union field
|
|
boolean |
|
codeable_concept |
|
Dose
Amount of medication per dose
| Fields | |
|---|---|
Union field
|
|
range |
|
quantity |
|
Rate
Amount of medication per unit of time
| Fields | |
|---|---|
Union field
|
|
ratio |
|
range |
|
quantity |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
value |
Numerical value (with implicit precision) |
comparator |
< | <= | >= | > - how to understand the value |
unit |
Unit representation |
system |
System that defines coded unit form |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
path |
Path of the element in the hierarchy of elements |
representation[] |
xmlAttr | xmlText | typeAttr | cdaText | xhtml |
slice_name |
Name for this particular element (in a set of slices) |
label |
Name for element to display with or prompt for element |
code[] |
Corresponding codes in terminologies |
slicing |
|
short |
Concise definition for space-constrained presentation |
definition |
Full formal definition as narrative text |
comment |
Comments about the use of this element |
requirements |
Why this resource has been created |
alias[] |
Other names |
min |
Minimum Cardinality |
max |
Maximum Cardinality (a number or *) |
base |
|
content_reference |
Reference to definition of content for the element |
type[] |
|
default_value |
|
meaning_when_missing |
Implicit meaning when this element is missing |
order_meaning |
What the order of the elements means |
fixed |
|
pattern |
|
example[] |
|
min_value |
|
max_value |
|
max_length |
Max length for strings |
condition[] |
Reference to invariant about presence |
constraint[] |
|
must_support |
If the element must supported |
is_modifier |
If this modifies the meaning of other elements |
is_summary |
Include when _summary = true? |
binding |
|
mapping[] |
|
Base
Base definition information for tools
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
path |
Path that identifies the base element |
min |
Min cardinality of the base element |
max |
Max cardinality of the base element |
Constraint
Condition that must evaluate to true
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
key |
Target of 'condition' reference above |
requirements |
Why this constraint is necessary or appropriate |
severity |
error | warning |
human |
Human description of constraint |
expression |
FHIRPath expression of constraint |
xpath |
XPath expression of constraint |
source |
Reference to original source of constraint |
DefaultValue
Specified value if missing from instance
| Fields | |
|---|---|
Union field
|
|
base64_binary |
|
boolean |
|
code |
|
date |
|
date_time |
|
decimal |
|
id |
|
instant |
|
integer |
|
markdown |
|
oid |
|
positive_int |
|
string_value |
|
time |
|
unsigned_int |
|
uri |
|
address |
|
age |
|
annotation |
|
attachment |
|
codeable_concept |
|
coding |
|
contact_point |
|
count |
|
distance |
|
duration |
|
human_name |
|
identifier |
|
money |
|
period |
|
quantity |
|
range |
|
ratio |
|
reference |
|
sampled_data |
|
signature |
|
timing |
|
meta |
|
ElementDefinitionBinding
ValueSet details if this is coded
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
strength |
required | extensible | preferred | example |
description |
Human explanation of the value set |
value_set |
|
ValueSet
Source of value set
| Fields | |
|---|---|
Union field
|
|
uri |
|
reference |
|
Example
Example value (as defined for type)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
label |
Describes the purpose of this example |
value |
|
Value
Value of Example (one of allowed types)
| Fields | |
|---|---|
Union field
|
|
base64_binary |
|
boolean |
|
code |
|
date |
|
date_time |
|
decimal |
|
id |
|
instant |
|
integer |
|
markdown |
|
oid |
|
positive_int |
|
string_value |
|
time |
|
unsigned_int |
|
uri |
|
address |
|
age |
|
annotation |
|
attachment |
|
codeable_concept |
|
coding |
|
contact_point |
|
count |
|
distance |
|
duration |
|
human_name |
|
identifier |
|
money |
|
period |
|
quantity |
|
range |
|
ratio |
|
reference |
|
sampled_data |
|
signature |
|
timing |
|
meta |
|
Fixed
Value must be exactly this
| Fields | |
|---|---|
Union field
|
|
base64_binary |
|
boolean |
|
code |
|
date |
|
date_time |
|
decimal |
|
id |
|
instant |
|
integer |
|
markdown |
|
oid |
|
positive_int |
|
string_value |
|
time |
|
unsigned_int |
|
uri |
|
address |
|
age |
|
annotation |
|
attachment |
|
codeable_concept |
|
coding |
|
contact_point |
|
count |
|
distance |
|
duration |
|
human_name |
|
identifier |
|
money |
|
period |
|
quantity |
|
range |
|
ratio |
|
reference |
|
sampled_data |
|
signature |
|
timing |
|
meta |
|
Mapping
Map element to another set of definitions
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
identity |
Reference to mapping declaration |
language |
Computable language of mapping |
map |
Details of the mapping |
comment |
Comments about the mapping or its use |
MaxValue
Maximum Allowed Value (for some types)
| Fields | |
|---|---|
Union field
|
|
date |
|
date_time |
|
instant |
|
time |
|
decimal |
|
integer |
|
positive_int |
|
unsigned_int |
|
quantity |
|
MinValue
Minimum Allowed Value (for some types)
| Fields | |
|---|---|
Union field
|
|
date |
|
date_time |
|
instant |
|
time |
|
decimal |
|
integer |
|
positive_int |
|
unsigned_int |
|
quantity |
|
Pattern
Value must have at least these property values
| Fields | |
|---|---|
Union field
|
|
base64_binary |
|
boolean |
|
code |
|
date |
|
date_time |
|
decimal |
|
id |
|
instant |
|
integer |
|
markdown |
|
oid |
|
positive_int |
|
string_value |
|
time |
|
unsigned_int |
|
uri |
|
address |
|
age |
|
annotation |
|
attachment |
|
codeable_concept |
|
coding |
|
contact_point |
|
count |
|
distance |
|
duration |
|
human_name |
|
identifier |
|
money |
|
period |
|
quantity |
|
range |
|
ratio |
|
reference |
|
sampled_data |
|
signature |
|
timing |
|
meta |
|
Slicing
This element is sliced - slices follow
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
discriminator[] |
|
description |
Text description of how slicing works (or not) |
ordered |
If elements must be in same order as slices |
rules |
closed | open | openAtEnd |
Discriminator
Element values that are used to distinguish the slices
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
type |
value | exists | pattern | type | profile |
path |
Path to element value |
TypeRef
Data type and Profile for this element
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
code |
Data type or Resource (reference to definition) |
profile |
Profile (StructureDefinition) to apply (or IG) |
target_profile |
Profile (StructureDefinition) to apply to reference target (or IG) |
aggregation[] |
contained | referenced | bundled - how aggregated |
versioning |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier |
status |
active | cancelled | draft | entered-in-error |
priority |
Desired processing priority |
patient |
The subject of the Products and Services |
serviced |
|
created |
Creation date |
enterer |
Author |
provider |
Responsible practitioner |
organization |
Responsible organization |
insurer |
Target |
facility |
Servicing Facility |
coverage |
Insurance or medical plan |
business_arrangement |
Business agreement |
benefit_category |
Type of services covered |
benefit_sub_category |
Detailed services covered within the type |
Serviced
Estimated date or dates of Service
| Fields | |
|---|---|
Union field
|
|
date |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier |
status |
active | cancelled | draft | entered-in-error |
created |
Creation date |
request_provider |
Responsible practitioner |
request_organization |
Responsible organization |
request |
Eligibility reference |
outcome |
complete | error | partial |
disposition |
Disposition Message |
insurer |
Insurer issuing the coverage |
inforce |
Coverage inforce indicator |
insurance[] |
|
form |
Printed Form Identifier |
error[] |
|
Errors
Processing errors
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Error code detailing processing issues |
Insurance
Details by insurance coverage
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
coverage |
Updated Coverage details |
contract |
Contract details |
benefit_balance[] |
|
Benefits
Benefits by Category
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
category |
Type of services covered |
sub_category |
Detailed services covered within the type |
excluded |
Excluded from the plan |
name |
Short name for the benefit |
description |
Description of the benefit or services covered |
network |
In or out of network |
unit |
Individual or family |
term |
Annual or lifetime |
financial[] |
|
Benefit
Benefit Summary
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Deductable, visits, benefit amount |
allowed |
|
used |
|
Allowed
Benefits allowed
| Fields | |
|---|---|
Union field
|
|
unsigned_int |
|
string_value |
|
money |
|
Used
Benefits used
| Fields | |
|---|---|
Union field
|
|
unsigned_int |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Identifier(s) by which this encounter is known |
status |
planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
status_history[] |
|
class_value |
inpatient | outpatient | ambulatory | emergency + |
class_history[] |
|
type[] |
Specific type of encounter |
priority |
Indicates the urgency of the encounter |
subject |
The patient ro group present at the encounter |
episode_of_care[] |
Episode(s) of care that this encounter should be recorded against |
incoming_referral[] |
The ReferralRequest that initiated this encounter |
participant[] |
|
appointment |
The appointment that scheduled this encounter |
period |
The start and end time of the encounter |
length |
Quantity of time the encounter lasted (less time absent) |
reason[] |
Reason the encounter takes place (code) |
diagnosis[] |
|
account[] |
The set of accounts that may be used for billing for this Encounter |
hospitalization |
|
location[] |
|
service_provider |
The custodian organization of this Encounter record |
part_of |
Another Encounter this encounter is part of |
ClassHistory
List of past encounter classes
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
class_value |
inpatient | outpatient | ambulatory | emergency + |
period |
The time that the episode was in the specified class |
Diagnosis
The list of diagnosis relevant to this encounter
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
condition |
Reason the encounter takes place (resource) |
role |
Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) |
rank |
Ranking of the diagnosis (for each role type) |
Hospitalization
Details about the admission to a healthcare service
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
pre_admission_identifier |
Pre-admission identifier |
origin |
The location from which the patient came before admission |
admit_source |
From where patient was admitted (physician referral, transfer) |
re_admission |
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[] |
Diet preferences reported by the patient |
special_courtesy[] |
Special courtesies (VIP, board member) |
special_arrangement[] |
Wheelchair, translator, stretcher, etc. |
destination |
Location to which the patient is discharged |
discharge_disposition |
Category or kind of location after discharge |
Location
List of locations where the patient has been
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
location |
Location the encounter takes place |
status |
planned | active | reserved | completed |
period |
Time period during which the patient was present at the location |
Participant
List of participants involved in the encounter
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type[] |
Role of participant in encounter |
period |
Period of time during the encounter that the participant participated |
individual |
Persons involved in the encounter other than the patient |
StatusHistory
List of past encounter statuses
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
status |
planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Identifies this endpoint across multiple systems |
status |
active | suspended | error | off | entered-in-error | test |
connection_type |
Protocol/Profile/Standard to be used with this endpoint connection |
name |
A name that this endpoint can be identified by |
managing_organization |
Organization that manages this endpoint (may not be the organization that exposes the endpoint) |
contact[] |
Contact details for source (e.g. troubleshooting) |
period |
Interval the endpoint is expected to be operational |
payload_type[] |
The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
payload_mime_type[] |
Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) |
address |
The technical base address for connecting to this endpoint |
header[] |
Usage depends on the channel type |
EndpointStatusCode
The status of the endpoint See http://hl7.org/fhir/ValueSet/endpoint-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier |
status |
active | cancelled | draft | entered-in-error |
created |
Creation date |
insurer |
Target |
provider |
Responsible practitioner |
organization |
Responsible organization |
subject |
The subject of the Products and Services |
coverage |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier |
status |
active | cancelled | draft | entered-in-error |
request |
Claim reference |
outcome |
complete | error | partial |
disposition |
Disposition Message |
created |
Creation date |
organization |
Insurer |
request_provider |
Responsible practitioner |
request_organization |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier(s) relevant for this EpisodeOfCare |
status |
planned | waitlist | active | onhold | finished | cancelled | entered-in-error |
status_history[] |
|
type[] |
Type/class - e.g. specialist referral, disease management |
diagnosis[] |
|
patient |
The patient who is the focus of this episode of care |
managing_organization |
Organization that assumes care |
period |
Interval during responsibility is assumed |
referral_request[] |
Originating Referral Request(s) |
care_manager |
Care manager/care co-ordinator for the patient |
team[] |
Other practitioners facilitating this episode of care |
account[] |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
condition |
Conditions/problems/diagnoses this episode of care is for |
role |
Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) |
rank |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
status |
planned | waitlist | active | onhold | finished | cancelled | entered-in-error |
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this expansion profile (globally unique) |
identifier |
Additional identifier for the expansion profile |
version |
Business version of the expansion profile |
name |
Name for this expansion profile (computer friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the expansion profile |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for expansion profile (if applicable) |
fixed_version[] |
|
excluded_system |
|
include_designations |
Whether the expansion should include concept designations |
designation |
|
include_definition |
Include or exclude the value set definition in the expansion |
active_only |
Include or exclude inactive concepts in the expansion |
exclude_nested |
Nested codes in the expansion or not |
exclude_not_for_ui |
Include or exclude codes which cannot be rendered in user interfaces in the value set expansion |
exclude_post_coordinated |
Include or exclude codes which are post coordinated expressions in the value set expansion |
display_language |
Specify the language for the display element of codes in the value set expansion |
limited_expansion |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
include |
|
exclude |
|
DesignationExclude
Designations to be excluded
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
designation[] |
|
DesignationExcludeDesignation
The designation to be excluded
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
language |
Human language of the designation to be excluded |
use |
What kind of Designation to exclude |
DesignationInclude
Designations to be included
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
designation[] |
|
DesignationIncludeDesignation
The designation to be included
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
language |
Human language of the designation to be included |
use |
What kind of Designation to include |
ExcludedSystem
Systems/Versions to be exclude
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
system |
The specific code system to be excluded |
version |
Specific version of the code system referred to |
FixedVersion
Fix use of a code system to a particular version
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
system |
System to have its version fixed |
version |
Specific version of the code system referred to |
mode |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier |
status |
active | cancelled | draft | entered-in-error |
type |
Type or discipline |
sub_type[] |
Finer grained claim type information |
patient |
The subject of the Products and Services |
billable_period |
Period for charge submission |
created |
Creation date |
enterer |
Author |
insurer |
Insurer responsible for the EOB |
provider |
Responsible provider for the claim |
organization |
Responsible organization for the claim |
referral |
Treatment Referral |
facility |
Servicing Facility |
claim |
Claim reference |
claim_response |
Claim response reference |
outcome |
complete | error | partial |
disposition |
Disposition Message |
related[] |
|
prescription |
Prescription authorizing services or products |
original_prescription |
Original prescription if superceded by fulfiller |
payee |
|
information[] |
|
care_team[] |
|
diagnosis[] |
|
procedure[] |
|
precedence |
Precedence (primary, secondary, etc.) |
insurance |
|
accident |
|
employment_impacted |
Period unable to work |
hospitalization |
Period in hospital |
item[] |
|
add_item[] |
|
total_cost |
Total Cost of service from the Claim |
unalloc_deductable |
Unallocated deductable |
total_benefit |
Total benefit payable for the Claim |
payment |
|
form |
Printed Form Identifier |
process_note[] |
|
benefit_balance[] |
|
Accident
Details of an accident
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
date |
When the accident occurred |
type |
The nature of the accident |
location |
|
Location
Accident Place
| Fields | |
|---|---|
Union field
|
|
address |
|
reference |
|
AddedItem
Insurer added line items
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence_link_id[] |
Service instances |
revenue |
Revenue or cost center code |
category |
Type of service or product |
service |
Billing Code |
modifier[] |
Service/Product billing modifiers |
fee |
Professional fee or Product charge |
note_number[] |
List of note numbers which apply |
adjudication[] |
Added items adjudication |
detail[] |
|
AddedItemsDetail
Added items details
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
revenue |
Revenue or cost center code |
category |
Type of service or product |
service |
Billing Code |
modifier[] |
Service/Product billing modifiers |
fee |
Professional fee or Product charge |
note_number[] |
List of note numbers which apply |
adjudication[] |
Added items detail adjudication |
BenefitBalance
Balance by Benefit Category
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
category |
Type of services covered |
sub_category |
Detailed services covered within the type |
excluded |
Excluded from the plan |
name |
Short name for the benefit |
description |
Description of the benefit or services covered |
network |
In or out of network |
unit |
Individual or family |
term |
Annual or lifetime |
financial[] |
|
Benefit
Benefit Summary
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Deductable, visits, benefit amount |
allowed |
|
used |
|
Allowed
Benefits allowed
| Fields | |
|---|---|
Union field
|
|
unsigned_int |
|
string_value |
|
money |
|
Used
Benefits used
| Fields | |
|---|---|
Union field
|
|
unsigned_int |
|
money |
|
CareTeam
Care Team members
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Number to covey order of careteam |
provider |
Member of the Care Team |
responsible |
Billing practitioner |
role |
Role on the team |
qualification |
Type, classification or Specialization |
Diagnosis
List of Diagnosis
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Number to covey order of diagnosis |
diagnosis |
|
type[] |
Timing or nature of the diagnosis |
package_code |
Package billing code |
DiagnosisType
Patient's diagnosis
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Insurance
Insurance or medical plan
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
coverage |
Insurance information |
pre_auth_ref[] |
Pre-Authorization/Determination Reference |
Item
Goods and Services
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Service instance |
care_team_link_id[] |
Applicable careteam members |
diagnosis_link_id[] |
Applicable diagnoses |
procedure_link_id[] |
Applicable procedures |
information_link_id[] |
Applicable exception and supporting information |
revenue |
Revenue or cost center code |
category |
Type of service or product |
service |
Billing Code |
modifier[] |
Service/Product billing modifiers |
program_code[] |
Program specific reason for item inclusion |
serviced |
|
location |
|
quantity |
Count of Products or Services |
unit_price |
Fee, charge or cost per point |
factor |
Price scaling factor |
net |
Total item cost |
udi[] |
Unique Device Identifier |
body_site |
Service Location |
sub_site[] |
Service Sub-location |
encounter[] |
Encounters related to this billed item |
note_number[] |
List of note numbers which apply |
adjudication[] |
|
detail[] |
|
Adjudication
Adjudication details
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
category |
Adjudication category such as co-pay, eligible, benefit, etc. |
reason |
Explanation of Adjudication outcome |
amount |
Monetary amount |
value |
Non-monitory value |
Detail
Additional items
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Service instance |
type |
Group or type of product or service |
revenue |
Revenue or cost center code |
category |
Type of service or product |
service |
Billing Code |
modifier[] |
Service/Product billing modifiers |
program_code[] |
Program specific reason for item inclusion |
quantity |
Count of Products or Services |
unit_price |
Fee, charge or cost per point |
factor |
Price scaling factor |
net |
Total additional item cost |
udi[] |
Unique Device Identifier |
note_number[] |
List of note numbers which apply |
adjudication[] |
Detail level adjudication details |
sub_detail[] |
|
SubDetail
Additional items
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Service instance |
type |
Type of product or service |
revenue |
Revenue or cost center code |
category |
Type of service or product |
service |
Billing Code |
modifier[] |
Service/Product billing modifiers |
program_code[] |
Program specific reason for item inclusion |
quantity |
Count of Products or Services |
unit_price |
Fee, charge or cost per point |
factor |
Price scaling factor |
net |
Net additional item cost |
udi[] |
Unique Device Identifier |
note_number[] |
List of note numbers which apply |
adjudication[] |
Language if different from the resource |
Location
Place of service
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
address |
|
reference |
|
Serviced
Date or dates of Service
| Fields | |
|---|---|
Union field
|
|
date |
|
period |
|
Note
Processing notes
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
number |
Sequence number for this note |
type |
display | print | printoper |
text |
Note explanitory text |
language |
Language if different from the resource |
Payee
Party to be paid any benefits payable
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Type of party: Subscriber, Provider, other |
resource_type |
organization | patient | practitioner | relatedperson |
party |
Party to receive the payable |
Payment
Payment (if paid)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Partial or Complete |
adjustment |
Payment adjustment for non-Claim issues |
adjustment_reason |
Explanation for the non-claim adjustment |
date |
Expected date of Payment |
amount |
Payable amount after adjustment |
identifier |
Identifier of the payment instrument |
Procedure
Procedures performed
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Procedure sequence for reference |
date |
When the procedure was performed |
procedure |
|
ProcedureType
Patient's list of procedures performed
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
RelatedClaim
Related Claims which may be revelant to processing this claim
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
claim |
Reference to the related claim |
relationship |
How the reference claim is related |
reference |
Related file or case reference |
SupportingInformation
Exceptions, special considerations, the condition, situation, prior or concurrent issues
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence |
Information instance identifier |
category |
General class of information |
code |
Type of information |
timing |
|
value |
|
reason |
Reason associated with the information |
TimingType
When it occurred
| Fields | |
|---|---|
Union field
|
|
date |
|
period |
|
Value
Additional Data or supporting information
| Fields | |
|---|---|
Union field
|
|
string_value |
|
quantity |
|
attachment |
|
reference |
|
ExplanationOfBenefitStatusCode
A code specifying the state of the resource instance. See http://hl7.org/fhir/ValueSet/explanationofbenefit-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
url |
identifies the meaning of the extension |
value |
|
extension[] |
Additional Content defined by implementations |
ValueX
Value of extension
| Fields | |
|---|---|
Union field
|
|
base64_binary |
|
boolean |
|
code |
|
date |
|
date_time |
|
decimal |
|
id |
|
instant |
|
integer |
|
markdown |
|
oid |
|
positive_int |
|
string_value |
|
time |
|
unsigned_int |
|
uri |
|
address |
|
age |
|
annotation |
|
attachment |
|
codeable_concept |
|
coding |
|
contact_point |
|
count |
|
distance |
|
duration |
|
human_name |
|
identifier |
|
money |
|
period |
|
quantity |
|
range |
|
ratio |
|
reference |
|
sampled_data |
|
signature |
|
timing |
|
meta |
|
ExtensionContextCode
How an extension context is interpreted. See http://hl7.org/fhir/ValueSet/extension-context
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
extension[] |
|
FHIRDeviceStatusCode
The availability status of the device. See http://hl7.org/fhir/ValueSet/device-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Id(s) for this record |
definition[] |
Instantiates protocol or definition |
status |
partial | completed | entered-in-error | health-unknown |
not_done |
The taking of a family member's history did not occur |
not_done_reason |
subject-unknown | withheld | unable-to-obtain | deferred |
patient |
Patient history is about |
date |
When history was captured/updated |
name |
The family member described |
relationship |
Relationship to the subject |
gender |
male | female | other | unknown |
born |
|
age |
|
estimated_age |
Age is estimated? |
deceased |
|
reason_code[] |
Why was family member history performed? |
reason_reference[] |
Why was family member history performed? |
note[] |
General note about related person |
condition[] |
|
AgeType
(approximate) age
| Fields | |
|---|---|
Union field
|
|
age_value |
|
range |
|
string_value |
|
Born
(approximate) date of birth
| Fields | |
|---|---|
Union field
|
|
period |
|
date |
|
string_value |
|
Condition
Condition that the related person had
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Condition suffered by relation |
outcome |
deceased | permanent disability | etc. |
onset |
|
note[] |
Extra information about condition |
Onset
When condition first manifested
| Fields | |
|---|---|
Union field
|
|
age |
|
range |
|
period |
|
string_value |
|
Deceased
Dead? How old/when?
| Fields | |
|---|---|
Union field
|
|
boolean |
|
age |
|
range |
|
date |
|
string_value |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business identifier |
status |
active | inactive | entered-in-error |
category |
Clinical, administrative, etc. |
code |
Coded or textual message to display to user |
subject |
Who/What is flag about? |
period |
Time period when flag is active |
encounter |
Alert relevant during encounter |
author |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Ids for this goal |
status |
proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected |
category[] |
E.g. Treatment, dietary, behavioral, etc. |
priority |
high-priority | medium-priority | low-priority |
description |
Code or text describing goal |
subject |
Who this goal is intended for |
start |
|
target |
|
status_date |
When goal status took effect |
status_reason |
Reason for current status |
expressed_by |
Who's responsible for creating Goal? |
addresses[] |
Issues addressed by this goal |
note[] |
Comments about the goal |
outcome_code[] |
What result was achieved regarding the goal? |
outcome_reference[] |
Observation that resulted from goal |
Start
When goal pursuit begins
| Fields | |
|---|---|
Union field
|
|
date |
|
codeable_concept |
|
Target
Target outcome for the goal
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
measure |
The parameter whose value is being tracked |
detail |
|
due |
|
Detail
The target value to be achieved
| Fields | |
|---|---|
Union field
|
|
quantity |
|
range |
|
codeable_concept |
|
Due
Reach goal on or before
| Fields | |
|---|---|
Union field
|
|
date |
|
duration |
|
GoalStatusCode
Indicates whether the goal has been met and is still being targeted See http://hl7.org/fhir/ValueSet/goal-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this graph definition (globally unique) |
version |
Business version of the graph definition |
name |
Name for this graph definition (computer friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the graph definition |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for graph definition (if applicable) |
purpose |
Why this graph definition is defined |
start |
Type of resource at which the graph starts |
profile |
Profile on base resource |
link[] |
|
Link
Links this graph makes rules about
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
path |
Path in the resource that contains the link |
slice_name |
Which slice (if profiled) |
min |
Minimum occurrences for this link |
max |
Maximum occurrences for this link |
description |
Why this link is specified |
target[] |
|
Target
Potential target for the link
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Type of resource this link refers to |
profile |
Profile for the target resource |
compartment[] |
|
link[] |
Additional links from target resource |
Compartment
Compartment Consistency Rules
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Identifies the compartment |
rule |
identical | matching | different | custom |
expression |
Custom rule, as a FHIRPath expression |
description |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Unique id |
active |
Whether this group's record is in active use |
type |
person | animal | practitioner | device | medication | substance |
actual |
Descriptive or actual |
code |
Kind of Group members |
name |
Label for Group |
quantity |
Number of members |
characteristic[] |
|
member[] |
|
Characteristic
Trait of group members
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Kind of characteristic |
value |
|
exclude |
Group includes or excludes |
period |
Period over which characteristic is tested |
Value
Value held by characteristic
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
boolean |
|
quantity |
|
range |
|
Member
Who or what is in group
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
entity |
Reference to the group member |
period |
Period member belonged to the group |
inactive |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
request_id |
The id of the request associated with this response, if any |
identifier |
Business identifier |
module |
A reference to a knowledge module |
status |
success | data-requested | data-required | in-progress | failure | entered-in-error |
subject |
Patient the request was performed for |
context |
Encounter or Episode during which the response was returned |
occurrence_date_time |
When the guidance response was processed |
performer |
Device returning the guidance |
reason |
|
note[] |
Additional notes about the response |
evaluation_message[] |
Messages resulting from the evaluation of the artifact or artifacts |
output_parameters |
The output parameters of the evaluation, if any |
result |
Proposed actions, if any |
data_requirement[] |
Additional required data |
Reason
Reason for the response
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
GuidanceResponseStatusCode
The status of a guidance response See http://hl7.org/fhir/ValueSet/guidance-response-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External identifiers for this item |
active |
Whether this healthcareservice is in active use |
provided_by |
Organization that provides this service |
category |
Broad category of service being performed or delivered |
type[] |
Type of service that may be delivered or performed |
specialty[] |
Specialties handled by the HealthcareService |
location[] |
Location(s) where service may be provided |
name |
Description of service as presented to a consumer while searching |
comment |
Additional description and/or any specific issues not covered elsewhere |
extra_details |
Extra details about the service that can't be placed in the other fields |
photo |
Facilitates quick identification of the service |
telecom[] |
Contacts related to the healthcare service |
coverage_area[] |
Location(s) service is inteded for/available to |
service_provision_code[] |
Conditions under which service is available/offered |
eligibility |
Specific eligibility requirements required to use the service |
eligibility_note |
Describes the eligibility conditions for the service |
program_name[] |
Program Names that categorize the service |
characteristic[] |
Collection of characteristics (attributes) |
referral_method[] |
Ways that the service accepts referrals |
appointment_required |
If an appointment is required for access to this service |
available_time[] |
|
not_available[] |
|
availability_exceptions |
Description of availability exceptions |
endpoint[] |
Technical endpoints providing access to services operated for the location |
AvailableTime
Times the Service Site is available
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
days_of_week[] |
mon | tue | wed | thu | fri | sat | sun |
all_day |
Always available? e.g. 24 hour service |
available_start_time |
Opening time of day (ignored if allDay = true) |
available_end_time |
Closing time of day (ignored if allDay = true) |
NotAvailable
Not available during this time due to provided reason
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
description |
Reason presented to the user explaining why time not available |
during |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
use |
usual | official | temp | nickname | anonymous | old | maiden |
text |
Text representation of the full name |
family |
Family name (often called 'Surname') |
given[] |
Given names (not always 'first'). Includes middle names |
prefix[] |
Parts that come before the name |
suffix[] |
Parts that come after the name |
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 |
Primitive value for id |
id |
xml:id (or equivalent in JSON) |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
use |
usual | official | temp | secondary (If known) |
type |
Description of identifier |
system |
The namespace for the identifier value |
value |
The value that is unique |
period |
Time period when id is/was valid for use |
assigner |
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 |
|
id |
xml:id (or equivalent in JSON) |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
SOP Instance UID |
patient |
Patient of the selected objects |
authoring_time |
Time when the selection of instances was made |
author |
Author (human or machine) |
description |
Description text |
study[] |
|
Study
Study identity of the selected instances
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
uid |
Study instance UID |
imaging_study |
Reference to ImagingStudy |
endpoint[] |
Study access service endpoint |
series[] |
|
Series
Series identity of the selected instances
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
uid |
Series instance UID |
endpoint[] |
Series access endpoint |
instance[] |
|
Instance
The selected instance
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sop_class |
SOP class UID of instance |
uid |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
uid |
Formal DICOM identifier for the study |
accession |
Related workflow identifier ("Accession Number") |
identifier[] |
Other identifiers for the study |
availability |
ONLINE | OFFLINE | NEARLINE | UNAVAILABLE |
modality_list[] |
All series modality if actual acquisition modalities |
patient |
Who the images are of |
context |
Originating context |
started |
When the study was started |
based_on[] |
Request fulfilled |
referrer |
Referring physician |
interpreter[] |
Who interpreted images |
endpoint[] |
Study access endpoint |
number_of_series |
Number of Study Related Series |
number_of_instances |
Number of Study Related Instances |
procedure_reference[] |
The performed Procedure reference |
procedure_code[] |
The performed procedure code |
reason |
Why the study was requested |
description |
Institution-generated description |
series[] |
|
Series
Each study has one or more series of instances
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
uid |
Formal DICOM identifier for this series |
number |
Numeric identifier of this series |
modality |
The modality of the instances in the series |
description |
A short human readable summary of the series |
number_of_instances |
Number of Series Related Instances |
availability |
ONLINE | OFFLINE | NEARLINE | UNAVAILABLE |
endpoint[] |
Series access endpoint |
body_site |
Body part examined |
laterality |
Body part laterality |
started |
When the series started |
performer[] |
Who performed the series |
instance[] |
|
Instance
A single SOP instance from the series
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
uid |
Formal DICOM identifier for this instance |
number |
The number of this instance in the series |
sop_class |
DICOM class type |
title |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business identifier |
status |
completed | entered-in-error |
not_given |
Flag for whether immunization was given |
vaccine_code |
Vaccine product administered |
patient |
Who was immunized |
encounter |
Encounter administered as part of |
date |
Vaccination administration date |
primary_source |
Indicates context the data was recorded in |
report_origin |
Indicates the source of a secondarily reported record |
location |
Where vaccination occurred |
manufacturer |
Vaccine manufacturer |
lot_number |
Vaccine lot number |
expiration_date |
Vaccine expiration date |
site |
Body site vaccine was administered |
route |
How vaccine entered body |
dose_quantity |
Amount of vaccine administered |
practitioner[] |
|
note[] |
Vaccination notes |
explanation |
|
reaction[] |
|
vaccination_protocol[] |
|
Explanation
Administration/non-administration reasons
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
reason[] |
Why immunization occurred |
reason_not_given[] |
Why immunization did not occur |
Practitioner
Who performed event
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
role |
What type of performance was done |
actor |
Individual who was performing |
Reaction
Details of a reaction that follows immunization
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
date |
When reaction started |
detail |
Additional information on reaction |
reported |
Indicates self-reported reaction |
VaccinationProtocol
What protocol was followed
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
dose_sequence |
Dose number within series |
description |
Details of vaccine protocol |
authority |
Who is responsible for protocol |
series |
Name of vaccine series |
series_doses |
Recommended number of doses for immunity |
target_disease[] |
Disease immunized against |
dose_status |
Indicates if dose counts towards immunity |
dose_status_reason |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business identifier |
patient |
Who this profile is for |
recommendation[] |
|
Recommendation
Vaccine administration recommendations
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
date |
Date recommendation created |
vaccine_code |
Vaccine recommendation applies to |
target_disease |
Disease to be immunized against |
dose_number |
Recommended dose number |
forecast_status |
Vaccine administration status |
date_criterion[] |
|
protocol |
|
supporting_immunization[] |
Past immunizations supporting recommendation |
supporting_patient_information[] |
Patient observations supporting recommendation |
DateCriterion
Dates governing proposed immunization
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Type of date |
value |
Recommended date |
Protocol
Protocol used by recommendation
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
dose_sequence |
Dose number within sequence |
description |
Protocol details |
authority |
Who is responsible for protocol |
series |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this implementation guide (globally unique) |
version |
Business version of the implementation guide |
name |
Name for this implementation guide (computer friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the implementation guide |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for implementation guide (if applicable) |
copyright |
Use and/or publishing restrictions |
fhir_version |
FHIR Version this Implementation Guide targets |
dependency[] |
|
package_value[] |
|
global[] |
|
binary[] |
Image, css, script, etc. |
page |
|
Dependency
Another Implementation guide this depends on
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
reference | inclusion |
uri |
Where to find dependency |
Global
Profiles that apply globally
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Type this profiles applies to |
profile |
Profile that all resources must conform to |
Package
Group of resources as used in .page.package
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name used .page.package |
description |
Human readable text describing the package |
resource[] |
|
Resource
Resource in the implementation guide
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
example |
If not an example, has its normal meaning |
name |
Human Name for the resource |
description |
Reason why included in guide |
acronym |
Short code to identify the resource |
source |
|
example_for |
Resource this is an example of (if applicable) |
Source
Location of the resource
| Fields | |
|---|---|
Union field
|
|
uri |
|
reference |
|
Page
Page/Section in the Guide
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
source |
Where to find that page |
title |
Short title shown for navigational assistance |
kind |
page | example | list | include | directory | dictionary | toc | resource |
type[] |
Kind of resource to include in the list |
package_value[] |
Name of package to include |
format |
Format of the page (e.g. html, markdown, etc.) |
page[] |
Nested Pages / Sections |
InstanceAvailabilityCode
Availability of the resource See http://hl7.org/fhir/ValueSet/instance-availability
| Fields | |
|---|---|
value |
|
id |
|
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 |
Primitive value for instant |
timezone |
|
precision |
|
id |
xml:id (or equivalent in JSON) |
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 |
Primitive value for integer |
id |
xml:id (or equivalent in JSON) |
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 |
|
id |
|
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 |
|
id |
|
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 |
Primitive value for code |
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this library (globally unique) |
identifier[] |
Additional identifier for the library |
version |
Business version of the library |
name |
Name for this library (computer friendly) |
title |
Name for this library (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
type |
logic-library | model-definition | asset-collection | module-definition |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
description |
Natural language description of the library |
purpose |
Why this library is defined |
usage |
Describes the clinical usage of the library |
approval_date |
When the library was approved by publisher |
last_review_date |
When the library was last reviewed |
effective_period |
When the library is expected to be used |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for library (if applicable) |
topic[] |
E.g. Education, Treatment, Assessment, etc |
contributor[] |
A content contributor |
contact[] |
Contact details for the publisher |
copyright |
Use and/or publishing restrictions |
related_artifact[] |
Additional documentation, citations, etc. |
parameter[] |
Parameters defined by the library |
data_requirement[] |
What data is referenced by this library |
content[] |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
active |
Whether this linkage assertion is active or not |
author |
Who is responsible for linkages |
item[] |
|
Item
Item to be linked
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
source | alternate | historical |
resource |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business identifier |
status |
current | retired | entered-in-error |
mode |
working | snapshot | changes |
title |
Descriptive name for the list |
code |
What the purpose of this list is |
subject |
If all resources have the same subject |
encounter |
Context in which list created |
date |
When the list was prepared |
source |
Who and/or what defined the list contents (aka Author) |
ordered_by |
What order the list has |
note[] |
Comments about the list |
entry[] |
|
empty_reason |
Why list is empty |
Entry
Entries in the list
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
flag |
Status/Workflow information about this item |
deleted |
If this item is actually marked as deleted |
date |
When item added to list |
item |
Actual entry |
ListModeCode
The processing mode that applies to this list See http://hl7.org/fhir/ValueSet/list-mode
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Unique code or number identifying the location to its users |
status |
active | suspended | inactive |
operational_status |
The Operational status of the location (typically only for a bed/room) |
name |
Name of the location as used by humans |
alias[] |
A list of alternate names that the location is known as, or was known as in the past |
description |
Additional details about the location that could be displayed as further information to identify the location beyond its name |
mode |
instance | kind |
type |
Type of function performed |
telecom[] |
Contact details of the location |
address |
Physical location |
physical_type |
Physical form of the location |
position |
|
managing_organization |
Organization responsible for provisioning and upkeep |
part_of |
Another Location this one is physically part of |
endpoint[] |
Technical endpoints providing access to services operated for the location |
Position
The absolute geographic location
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
longitude |
Longitude with WGS84 datum |
latitude |
Latitude with WGS84 datum |
altitude |
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 |
|
id |
|
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 |
|
id |
|
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 |
Primitive value for markdown |
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
MeasmntPrincipleCode
Different measurement principle supported by the device. See http://hl7.org/fhir/ValueSet/measurement-principle
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this measure (globally unique) |
identifier[] |
Additional identifier for the measure |
version |
Business version of the measure |
name |
Name for this measure (computer friendly) |
title |
Name for this measure (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
description |
Natural language description of the measure |
purpose |
Why this measure is defined |
usage |
Describes the clinical usage of the measure |
approval_date |
When the measure was approved by publisher |
last_review_date |
When the measure was last reviewed |
effective_period |
When the measure is expected to be used |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for measure (if applicable) |
topic[] |
E.g. Education, Treatment, Assessment, etc |
contributor[] |
A content contributor |
contact[] |
Contact details for the publisher |
copyright |
Use and/or publishing restrictions |
related_artifact[] |
Additional documentation, citations, etc |
library[] |
Logic used by the measure |
disclaimer |
Disclaimer for use of the measure or its referenced content |
scoring |
proportion | ratio | continuous-variable | cohort |
composite_scoring |
opportunity | all-or-nothing | linear | weighted |
type[] |
process | outcome | structure | patient-reported-outcome | composite |
risk_adjustment |
How is risk adjustment applied for this measure |
rate_aggregation |
How is rate aggregation performed for this measure |
rationale |
Why does this measure exist |
clinical_recommendation_statement |
Summary of clinical guidelines |
improvement_notation |
Improvement notation for the measure, e.g. higher score indicates better quality |
definition[] |
Defined terms used in the measure documentation |
guidance |
Additional guidance for implementers |
set |
The measure set, e.g. Preventive Care and Screening |
group[] |
|
supplemental_data[] |
|
Group
Population criteria group
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Unique identifier |
name |
Short name |
description |
Summary description |
population[] |
|
stratifier[] |
|
Population
Population criteria
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Unique identifier |
code |
initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation |
name |
Short name |
description |
The human readable description of this population criteria |
criteria |
The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria |
Stratifier
Stratifier criteria for the measure
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
The identifier for the stratifier used to coordinate the reported data back to this stratifier |
criteria |
How the measure should be stratified |
path |
Path to the stratifier |
SupplementalData
What other data should be reported with the measure
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Identifier, unique within the measure |
usage[] |
supplemental-data | risk-adjustment-factor |
criteria |
Expression describing additional data to be reported |
path |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Additional identifier for the Report |
status |
complete | pending | error |
type |
individual | patient-list | summary |
measure |
What measure was evaluated |
patient |
What patient the report is for |
date |
When the report was generated |
reporting_organization |
Who is reporting the data |
period |
What period the report covers |
group[] |
|
evaluated_resources |
What data was evaluated to produce the measure score |
Group
Measure results for each group
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
What group of the measure |
population[] |
|
measure_score |
What score this group achieved |
stratifier[] |
|
Population
The populations in the group
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Population identifier as defined in the measure |
code |
initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score |
count |
Size of the population |
patients |
For patient-list reports, the patients in this population |
Stratifier
Stratification results
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
What stratifier of the group |
stratum[] |
|
StratifierGroup
Stratum results, one for each unique value in the stratifier
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
value |
The stratum value, e.g. male |
population[] |
|
measure_score |
What score this stratum achieved |
StratifierGroupPopulation
Population results in this stratum
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Population identifier as defined in the measure |
code |
initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score |
count |
Size of the population |
patients |
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Identifier(s) for the image |
based_on[] |
Procedure that caused this media to be created |
type |
photo | video | audio |
subtype |
The type of acquisition equipment/process |
view |
Imaging view, e.g. Lateral or Antero-posterior |
subject |
Who/What this Media is a record of |
context |
Encounter / Episode associated with media |
occurrence |
|
operator |
The person who generated the image |
reason_code[] |
Why was event performed? |
body_site |
Body part in media |
device |
Observing Device |
height |
Height of the image in pixels (photo/video) |
width |
Width of the image in pixels (photo/video) |
frames |
Number of frames if > 1 (photo) |
duration |
Length in seconds (audio / video) |
content |
Actual Media - reference or data |
note[] |
Comments made about the media |
Occurrence
When Media was collected
| Fields | |
|---|---|
Union field
|
|
date_time |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Codes that identify this medication |
status |
active | inactive | entered-in-error |
is_brand |
True if a brand |
is_over_the_counter |
True if medication does not require a prescription |
manufacturer |
Manufacturer of the item |
form |
powder | tablets | capsule + |
ingredient[] |
|
package_value |
|
image[] |
Picture of the medication |
Ingredient
Active or inactive ingredient
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
item |
|
is_active |
Active ingredient indicator |
amount |
Quantity of ingredient present |
Item
The product contained
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Package
Details about packaged medications
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
container |
E.g. box, vial, blister-pack |
content[] |
|
batch[] |
|
Batch
Identifies a single production run
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
lot_number |
Identifier assigned to batch |
expiration_date |
When batch will expire |
Content
What is in the package
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
item |
|
amount |
Quantity present in the package |
Item
The item in the package
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External identifier |
definition[] |
Instantiates protocol or definition |
part_of[] |
Part of referenced event |
status |
in-progress | on-hold | completed | entered-in-error | stopped | unknown |
category |
Type of medication usage |
medication |
|
subject |
Who received medication |
context |
Encounter or Episode of Care administered as part of |
supporting_information[] |
Additional information to support administration |
effective |
|
performer[] |
|
not_given |
True if medication not administered |
reason_not_given[] |
Reason administration not performed |
reason_code[] |
Reason administration performed |
reason_reference[] |
Condition or Observation that supports why the medication was administered |
prescription |
Request administration performed against |
device[] |
Device used to administer |
note[] |
Information about the administration |
dosage |
|
event_history[] |
A list of events of interest in the lifecycle |
Dosage
Details of how medication was taken
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
text |
Free text dosage instructions e.g. SIG |
site |
Body site administered to |
route |
Path of substance into body |
method |
How drug was administered |
dose |
Amount of medication per dose |
rate |
|
Rate
Dose quantity per unit of time
| Fields | |
|---|---|
Union field
|
|
ratio |
|
quantity |
|
Effective
Start and end time of administration
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
Medication
What was administered
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Performer
Who administered substance
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
actor |
Individual who was performing |
on_behalf_of |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External identifier |
part_of[] |
Event that dispense is part of |
status |
preparation | in-progress | on-hold | completed | entered-in-error | stopped |
category |
Type of medication dispense |
medication |
|
subject |
Who the dispense is for |
context |
Encounter / Episode associated with event |
supporting_information[] |
Information that supports the dispensing of the medication |
performer[] |
|
authorizing_prescription[] |
Medication order that authorizes the dispense |
type |
Trial fill, partial fill, emergency fill, etc. |
quantity |
Amount dispensed |
days_supply |
Amount of medication expressed as a timing amount |
when_prepared |
When product was packaged and reviewed |
when_handed_over |
When product was given out |
destination |
Where the medication was sent |
receiver[] |
Who collected the medication |
note[] |
Information about the dispense |
dosage_instruction[] |
How the medication is to be used by the patient or administered by the caregiver |
substitution |
|
detected_issue[] |
Clinical issue with action |
not_done |
Whether the dispense was or was not performed |
not_done_reason |
|
event_history[] |
A list of releveant lifecycle events |
Medication
What medication was supplied
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
NotDoneReason
Why a dispense was not performed
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Performer
Who performed event
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
actor |
Individual who was performing |
on_behalf_of |
Organization organization was acting for |
Substitution
Whether a substitution was performed on the dispense
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
was_substituted |
Whether a substitution was or was not performed on the dispense |
type |
Code signifying whether a different drug was dispensed from what was prescribed |
reason[] |
Why was substitution made |
responsible_party[] |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External ids for this request |
definition[] |
Protocol or definition |
based_on[] |
What request fulfills |
group_identifier |
Composite request this is part of |
status |
active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown |
intent |
proposal | plan | order | instance-order |
category |
Type of medication usage |
priority |
routine | urgent | stat | asap |
medication |
|
subject |
Who or group medication request is for |
context |
Created during encounter/admission/stay |
supporting_information[] |
Information to support ordering of the medication |
authored_on |
When request was initially authored |
requester |
|
recorder |
Person who entered the request |
reason_code[] |
Reason or indication for writing the prescription |
reason_reference[] |
Condition or Observation that supports why the prescription is being written |
note[] |
Information about the prescription |
dosage_instruction[] |
How the medication should be taken |
dispense_request |
|
substitution |
|
prior_prescription |
An order/prescription that is being replaced |
detected_issue[] |
Clinical Issue with action |
event_history[] |
A list of events of interest in the lifecycle |
DispenseRequest
Medication supply authorization
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
validity_period |
Time period supply is authorized for |
number_of_repeats_allowed |
Number of refills authorized |
quantity |
Amount of medication to supply per dispense |
expected_supply_duration |
Number of days supply per dispense |
performer |
Intended dispenser |
Medication
Medication to be taken
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Requester
Who/What requested the Request
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
agent |
Who ordered the initial medication(s) |
on_behalf_of |
Organization agent is acting for |
Substitution
Any restrictions on medication substitution
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
allowed |
Whether substitution is allowed or not |
reason |
Why should (not) substitution be made |
MedicationRequestIntentCode
The kind of medication order See http://hl7.org/fhir/ValueSet/medication-request-intent
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External identifier |
based_on[] |
Fulfils plan, proposal or order |
part_of[] |
Part of referenced event |
context |
Encounter / Episode associated with MedicationStatement |
status |
active | completed | entered-in-error | intended | stopped | on-hold |
category |
Type of medication usage |
medication |
|
effective |
|
date_asserted |
When the statement was asserted? |
information_source |
Person or organization that provided the information about the taking of this medication |
subject |
Who is/was taking the medication |
derived_from[] |
Additional supporting information |
taken |
y | n | unk | na |
reason_not_taken[] |
True if asserting medication was not given |
reason_code[] |
Reason for why the medication is being/was taken |
reason_reference[] |
Condition or observation that supports why the medication is being/was taken |
note[] |
Further information about the statement |
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
|
|
date_time |
|
period |
|
Medication
What medication was taken
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
MedicationStatementStatusCode
A coded concept indicating the current status of a MedicationStatement. See http://hl7.org/fhir/ValueSet/medication-statement-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this message definition (globally unique) |
identifier |
Additional identifier for the message definition |
version |
Business version of the message definition |
name |
Name for this message definition (computer friendly) |
title |
Name for this message definition (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the message definition |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for message definition (if applicable) |
purpose |
Why this message definition is defined |
copyright |
Use and/or publishing restrictions |
base |
Definition this one is based on |
parent[] |
Protocol/workflow this is part of |
replaces[] |
Takes the place of |
event |
Event type |
category |
Consequence | Currency | Notification |
focus[] |
|
response_required |
Is a response required? |
allowed_response[] |
|
AllowedResponse
Responses to this message
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
message |
Reference to allowed message definition response |
situation |
When should this response be used |
Focus
Resource(s) that are the subject of the event
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Type of resource |
profile |
Profile that must be adhered to by focus |
min |
Minimum number of focuses of this type |
max |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
event |
Code for the event this message represents |
destination[] |
|
receiver |
Intended "real-world" recipient for the data |
sender |
Real world sender of the message |
timestamp |
Time that the message was sent |
enterer |
The source of the data entry |
author |
The source of the decision |
source |
|
responsible |
Final responsibility for event |
reason |
Cause of event |
response |
|
focus[] |
The actual content of the message |
MessageDestination
Message destination application(s)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name of system |
target |
Particular delivery destination within the destination |
endpoint |
Actual destination address or id |
MessageSource
Message source application
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name of system |
software |
Name of software running the system |
version |
Version of software running |
contact |
Human contact for problems |
endpoint |
Actual message source address or id |
Response
If this is a reply to prior message
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Id of original message |
code |
ok | transient-error | fatal-error |
details |
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 |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
version_id |
Version specific identifier |
last_updated |
When the resource version last changed |
profile[] |
Profiles this resource claims to conform to |
security[] |
Security Labels applied to this resource |
tag[] |
Tags applied to this resource |
MimeTypeCode
Any valid MimeType. See http://www.rfc-editor.org/bcp/bcp13.txt
| Fields | |
|---|---|
value |
Primitive value for code |
id |
xml:id (or equivalent in JSON) |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
value |
Numerical value (with implicit precision) |
comparator |
< | <= | >= | > - how to understand the value |
unit |
Unit representation |
system |
System that defines coded unit form |
code |
Coded form of the unit |
NameUseCode
The use of a human name See http://hl7.org/fhir/ValueSet/name-use
| Fields | |
|---|---|
value |
|
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name for this naming system (computer friendly) |
status |
draft | active | retired | unknown |
kind |
codesystem | identifier | root |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
responsible |
Who maintains system namespace? |
type |
e.g. driver, provider, patient, bank etc. |
description |
Natural language description of the naming system |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for naming system (if applicable) |
usage |
How/where is it used |
unique_id[] |
|
replaced_by |
Use this instead |
UniqueId
Unique identifiers used for system
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
oid | uuid | uri | other |
value |
The unique identifier |
preferred |
Is this the id that should be used for this type |
comment |
Notes about identifier usage |
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 |
|
id |
|
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 |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
status |
generated | extensions | additional | empty |
div |
Limited xhtml content |
NarrativeStatusCode
The status of a resource narrative See http://hl7.org/fhir/ValueSet/narrative-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Identifiers assigned to this order |
status |
proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error |
patient |
The person who requires the diet, formula or nutritional supplement |
encounter |
The encounter associated with this nutrition order |
date_time |
Date and time the nutrition order was requested |
orderer |
Who ordered the diet, formula or nutritional supplement |
allergy_intolerance[] |
List of the patient's food and nutrition-related allergies and intolerances |
food_preference_modifier[] |
Order-specific modifier about the type of food that should be given |
exclude_food_modifier[] |
Order-specific modifier about the type of food that should not be given |
oral_diet |
|
supplement[] |
|
enteral_formula |
|
EnteralFormula
Enteral formula components
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
base_formula_type |
Type of enteral or infant formula |
base_formula_product_name |
Product or brand name of the enteral or infant formula |
additive_type |
Type of modular component to add to the feeding |
additive_product_name |
Product or brand name of the modular additive |
caloric_density |
Amount of energy per specified volume that is required |
routeof_administration |
How the formula should enter the patient's gastrointestinal tract |
administration[] |
|
max_volume_to_deliver |
Upper limit on formula volume per unit of time |
administration_instruction |
Formula feeding instructions expressed as text |
Administration
Formula feeding instruction as structured data
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
schedule |
Scheduled frequency of enteral feeding |
quantity |
The volume of formula to provide |
rate |
|
Rate
Speed with which the formula is provided per period of time
| Fields | |
|---|---|
Union field
|
|
quantity |
|
ratio |
|
OralDiet
Oral diet components
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type[] |
Type of oral diet or diet restrictions that describe what can be consumed orally |
schedule[] |
Scheduled frequency of diet |
nutrient[] |
|
texture[] |
|
fluid_consistency_type[] |
The required consistency of fluids and liquids provided to the patient |
instruction |
Instructions or additional information about the oral diet |
Nutrient
Required nutrient modifications
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
modifier |
Type of nutrient that is being modified |
amount |
Quantity of the specified nutrient |
Texture
Required texture modifications
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
modifier |
Code to indicate how to alter the texture of the foods, e.g. pureed |
food_type |
Concepts that are used to identify an entity that is ingested for nutritional purposes |
Supplement
Supplement components
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Type of supplement product requested |
product_name |
Product or brand name of the nutritional supplement |
schedule[] |
Scheduled frequency of supplement |
quantity |
Amount of the nutritional supplement |
instruction |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier for observation |
based_on[] |
Fulfills plan, proposal or order |
status |
registered | preliminary | final | amended + |
category[] |
Classification of type of observation |
code |
Type of observation (code / type) |
subject |
Who and/or what this is about |
context |
Healthcare event during which this observation is made |
effective |
|
issued |
Date/Time this was made available |
performer[] |
Who is responsible for the observation |
value |
|
data_absent_reason |
Why the result is missing |
interpretation |
High, low, normal, etc. |
comment |
Comments about result |
body_site |
Observed body part |
method |
How it was done |
specimen |
Specimen used for this observation |
device |
(Measurement) Device |
reference_range[] |
|
related[] |
|
component[] |
|
Component
Component results
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Type of component observation (code / type) |
value |
|
data_absent_reason |
Why the component result is missing |
interpretation |
High, low, normal, etc. |
reference_range[] |
Provides guide for interpretation of component result |
Value
Actual component result
| Fields | |
|---|---|
Union field
|
|
quantity |
|
codeable_concept |
|
string_value |
|
range |
|
ratio |
|
sampled_data |
|
attachment |
|
time |
|
date_time |
|
period |
|
Effective
Clinically relevant time/time-period for observation
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
ReferenceRange
Provides guide for interpretation
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
low |
Low Range, if relevant |
high |
High Range, if relevant |
type |
Reference range qualifier |
applies_to[] |
Reference range population |
age |
Applicable age range, if relevant |
text |
Text based reference range in an observation |
Related
Resource related to this observation
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by |
target |
Resource that is related to this one |
Value
Actual result
| Fields | |
|---|---|
Union field
|
|
quantity |
|
codeable_concept |
|
string_value |
|
boolean |
|
range |
|
ratio |
|
sampled_data |
|
attachment |
|
time |
|
date_time |
|
period |
|
ObservationRelationshipTypeCode
Codes specifying how two observations are related. See http://hl7.org/fhir/ValueSet/observation-relationshiptypes
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
Primitive value for oid |
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this operation definition (globally unique) |
version |
Business version of the operation definition |
name |
Name for this operation definition (computer friendly) |
status |
draft | active | retired | unknown |
kind |
operation | query |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the operation definition |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for operation definition (if applicable) |
purpose |
Why this operation definition is defined |
idempotent |
Whether content is unchanged by the operation |
code |
Name used to invoke the operation |
comment |
Additional information about use |
base |
Marks this as a profile of the base |
resource[] |
Types this operation applies to |
system |
Invoke at the system level? |
type |
Invole at the type level? |
instance |
Invoke on an instance? |
parameter[] |
|
overload[] |
|
Overload
Define overloaded variants for when generating code
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
parameter_name[] |
Name of parameter to include in overload |
comment |
Comments to go on overload |
Parameter
Parameters for the operation/query
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name in Parameters.parameter.name or in URL |
use |
in | out |
min |
Minimum Cardinality |
max |
Maximum Cardinality (a number or *) |
documentation |
Description of meaning/use |
type |
What type this parameter has |
search_type |
number | date | string | token | reference | composite | quantity | uri |
profile |
Profile on the type |
binding |
|
part[] |
Parts of a nested Parameter |
Binding
ValueSet details if this is coded
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
strength |
required | extensible | preferred | example |
value_set |
|
ValueSet
Source of value set
| Fields | |
|---|---|
Union field
|
|
uri |
|
reference |
|
OperationKindCode
Whether an operation is a normal operation or a query. See http://hl7.org/fhir/ValueSet/operation-kind
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
issue[] |
|
Issue
A single issue associated with the action
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
severity |
fatal | error | warning | information |
code |
Error or warning code |
details |
Additional details about the error |
diagnostics |
Additional diagnostic information about the issue |
location[] |
Path of element(s) related to issue |
expression[] |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Identifies this organization across multiple systems |
active |
Whether the organization's record is still in active use |
type[] |
Kind of organization |
name |
Name used for the organization |
alias[] |
A list of alternate names that the organization is known as, or was known as in the past |
telecom[] |
A contact detail for the organization |
address[] |
An address for the organization |
part_of |
The organization of which this organization forms a part |
contact[] |
|
endpoint[] |
Technical endpoints providing access to services operated for the organization |
Contact
Contact for the organization for a certain purpose
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
purpose |
The type of contact |
name |
A name associated with the contact |
telecom[] |
Contact details (telephone, email, etc.) for a contact |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
name |
Name used to access the parameter value |
use |
in | out |
min |
Minimum cardinality |
max |
Maximum cardinality (a number of *) |
documentation |
A brief description of the parameter |
type |
What type of value |
profile |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
parameter[] |
|
Parameter
Operation Parameter
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name from the definition |
value |
|
resource |
If parameter is a whole resource |
part[] |
Named part of a multi-part parameter |
Value
If parameter is a data type
| Fields | |
|---|---|
Union field
|
|
base64_binary |
|
boolean |
|
code |
|
date |
|
date_time |
|
decimal |
|
id |
|
instant |
|
integer |
|
markdown |
|
oid |
|
positive_int |
|
string_value |
|
time |
|
unsigned_int |
|
uri |
|
address |
|
age |
|
annotation |
|
attachment |
|
codeable_concept |
|
coding |
|
contact_point |
|
count |
|
distance |
|
duration |
|
human_name |
|
identifier |
|
money |
|
period |
|
quantity |
|
range |
|
ratio |
|
reference |
|
sampled_data |
|
signature |
|
timing |
|
meta |
|
ParticipantRequiredCode
Is the Participant required to attend the appointment. See http://hl7.org/fhir/ValueSet/participantrequired
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
An identifier for this patient |
active |
Whether this patient's record is in active use |
name[] |
A name associated with the patient |
telecom[] |
A contact detail for the individual |
gender |
male | female | other | unknown |
birth_date |
The date of birth for the individual |
deceased |
|
address[] |
Addresses for the individual |
marital_status |
Marital (civil) status of a patient |
multiple_birth |
|
photo[] |
Image of the patient |
contact[] |
|
animal |
|
communication[] |
|
general_practitioner[] |
Patient's nominated primary care provider |
managing_organization |
Organization that is the custodian of the patient record |
link[] |
|
Animal
This patient is known to be an animal (non-human)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
species |
E.g. Dog, Cow |
breed |
E.g. Poodle, Angus |
gender_status |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
language |
The language which can be used to communicate with the patient about his or her health |
preferred |
Language preference indicator |
Contact
A contact party (e.g. guardian, partner, friend) for the patient
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
relationship[] |
The kind of relationship |
name |
A name associated with the contact person |
telecom[] |
A contact detail for the person |
address |
Address for the contact person |
gender |
male | female | other | unknown |
organization |
Organization that is associated with the contact |
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
|
|
boolean |
|
date_time |
|
Link
Link to another patient resource that concerns the same actual person
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
other |
The other patient or related person resource that the link refers to |
type |
replaced-by | replaces | refer | seealso - type of link |
MultipleBirth
Whether patient is part of a multiple birth
| Fields | |
|---|---|
Union field
|
|
boolean |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier |
status |
active | cancelled | draft | entered-in-error |
request |
Request reference |
response |
Response reference |
status_date |
Payment or clearing date |
created |
Creation date |
target |
Insurer or Regulatory body |
provider |
Responsible practitioner |
organization |
Responsible organization |
payment_status |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier |
status |
active | cancelled | draft | entered-in-error |
period |
Period covered |
created |
Creation date |
organization |
Insurer |
request |
Claim reference |
outcome |
complete | error | partial |
disposition |
Disposition Message |
request_provider |
Responsible practitioner |
request_organization |
Responsible organization |
detail[] |
|
form |
Printed Form Identifier |
total |
Total amount of Payment |
process_note[] |
|
Details
List of settlements
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Type code |
request |
Claim |
response |
Claim Response |
submitter |
Organization which submitted the claim |
payee |
Organization which is receiving the payment |
date |
Invoice date |
amount |
Amount being paid |
Notes
Processing comments
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
display | print | printoper |
text |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
start |
Starting time with inclusive boundary |
end |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
A human identifier for this person |
name[] |
A name associated with the person |
telecom[] |
A contact detail for the person |
gender |
male | female | other | unknown |
birth_date |
The date on which the person was born |
address[] |
One or more addresses for the person |
photo |
Image of the person |
managing_organization |
The organization that is the custodian of the person record |
active |
This person's record is in active use |
link[] |
|
Link
Link to a resource that concerns the same actual person
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
target |
The resource to which this actual person is associated |
assurance |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this plan definition (globally unique) |
identifier[] |
Additional identifier for the plan definition |
version |
Business version of the plan definition |
name |
Name for this plan definition (computer friendly) |
title |
Name for this plan definition (human friendly) |
type |
order-set | protocol | eca-rule |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
description |
Natural language description of the plan definition |
purpose |
Why this plan definition is defined |
usage |
Describes the clinical usage of the asset |
approval_date |
When the plan definition was approved by publisher |
last_review_date |
When the plan definition was last reviewed |
effective_period |
When the plan definition is expected to be used |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for plan definition (if applicable) |
topic[] |
E.g. Education, Treatment, Assessment, etc |
contributor[] |
A content contributor |
contact[] |
Contact details for the publisher |
copyright |
Use and/or publishing restrictions |
related_artifact[] |
Related artifacts for the asset |
library[] |
Logic used by the plan definition |
goal[] |
|
action[] |
|
Action
Action defined by the plan
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
label |
User-visible label for the action (e.g. 1. or A.) |
title |
User-visible title |
description |
Short description of the action |
text_equivalent |
Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
code[] |
Code representing the meaning of the action or sub-actions |
reason[] |
Why the action should be performed |
documentation[] |
Supporting documentation for the intended performer of the action |
goal_id[] |
What goals this action supports |
trigger_definition[] |
When the action should be triggered |
condition[] |
|
input[] |
Input data requirements |
output[] |
Output data definition |
related_action[] |
|
timing |
|
participant[] |
|
type |
create | update | remove | fire-event |
grouping_behavior |
visual-group | logical-group | sentence-group |
selection_behavior |
any | all | all-or-none | exactly-one | at-most-one | one-or-more |
required_behavior |
must | could | must-unless-documented |
precheck_behavior |
yes | no |
cardinality_behavior |
single | multiple |
definition |
Description of the activity to be performed |
transform |
Transform to apply the template |
dynamic_value[] |
|
action[] |
A sub-action |
Condition
Whether or not the action is applicable
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
kind |
applicability | start | stop |
description |
Natural language description of the condition |
language |
Language of the expression |
expression |
Boolean-valued expression |
DynamicValue
Dynamic aspects of the definition
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
description |
Natural language description of the dynamic value |
path |
The path to the element to be set dynamically |
language |
Language of the expression |
expression |
An expression that provides the dynamic value for the customization |
Participant
Who should participate in the action
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
patient | practitioner | related-person |
role |
E.g. Nurse, Surgeon, Parent, etc |
RelatedAction
Relationship to another action
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
action_id |
What action is this related to |
relationship |
before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end |
offset |
|
Offset
Time offset for the relationship
| Fields | |
|---|---|
Union field
|
|
duration |
|
range |
|
TimingType
When the action should take place
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
duration |
|
range |
|
timing_value |
|
Goal
What the plan is trying to accomplish
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
category |
E.g. Treatment, dietary, behavioral, etc |
description |
Code or text describing the goal |
priority |
high-priority | medium-priority | low-priority |
start |
When goal pursuit begins |
addresses[] |
What does the goal address |
documentation[] |
Supporting documentation for the goal |
target[] |
|
Target
Target outcome for the goal
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
measure |
The parameter whose value is to be tracked |
detail |
|
due |
Reach goal within |
Detail
The target value to be achieved
| Fields | |
|---|---|
Union field
|
|
quantity |
|
range |
|
codeable_concept |
|
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 |
Primitive value for positiveInt |
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
A identifier for the person as this agent |
active |
Whether this practitioner's record is in active use |
name[] |
The name(s) associated with the practitioner |
telecom[] |
A contact detail for the practitioner (that apply to all roles) |
address[] |
Address(es) of the practitioner that are not role specific (typically home address) |
gender |
male | female | other | unknown |
birth_date |
The date on which the practitioner was born |
photo[] |
Image of the person |
qualification[] |
|
communication[] |
A language the practitioner is able to use in patient communication |
Qualification
Qualifications obtained by training and certification
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
An identifier for this qualification for the practitioner |
code |
Coded representation of the qualification |
period |
Period during which the qualification is valid |
issuer |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifiers that are specific to a role/location |
active |
Whether this practitioner's record is in active use |
period |
The period during which the practitioner is authorized to perform in these role(s) |
practitioner |
Practitioner that is able to provide the defined services for the organation |
organization |
Organization where the roles are available |
code[] |
Roles which this practitioner may perform |
specialty[] |
Specific specialty of the practitioner |
location[] |
The location(s) at which this practitioner provides care |
healthcare_service[] |
The list of healthcare services that this worker provides for this role's Organization/Location(s) |
telecom[] |
Contact details that are specific to the role/location/service |
available_time[] |
|
not_available[] |
|
availability_exceptions |
Description of availability exceptions |
endpoint[] |
Technical endpoints providing access to services operated for the practitioner with this role |
AvailableTime
Times the Service Site is available
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
days_of_week[] |
mon | tue | wed | thu | fri | sat | sun |
all_day |
Always available? e.g. 24 hour service |
available_start_time |
Opening time of day (ignored if allDay = true) |
available_end_time |
Closing time of day (ignored if allDay = true) |
NotAvailable
Not available during this time due to provided reason
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
description |
Reason presented to the user explaining why time not available |
during |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Identifiers for this procedure |
definition[] |
Instantiates protocol or definition |
based_on[] |
A request for this procedure |
part_of[] |
Part of referenced event |
status |
preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown |
not_done |
True if procedure was not performed as scheduled |
not_done_reason |
Reason procedure was not performed |
category |
Classification of the procedure |
code |
Identification of the procedure |
subject |
Who the procedure was performed on |
context |
Encounter or episode associated with the procedure |
performed |
|
performer[] |
|
location |
Where the procedure happened |
reason_code[] |
Coded reason procedure performed |
reason_reference[] |
Condition that is the reason the procedure performed |
body_site[] |
Target body sites |
outcome |
The result of procedure |
report[] |
Any report resulting from the procedure |
complication[] |
Complication following the procedure |
complication_detail[] |
A condition that is a result of the procedure |
follow_up[] |
Instructions for follow up |
note[] |
Additional information about the procedure |
focal_device[] |
|
used_reference[] |
Items used during procedure |
used_code[] |
Coded items used during the procedure |
FocalDevice
Device changed in procedure
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
action |
Kind of change to device |
manipulated |
Device that was changed |
Performed
Date/Period the procedure was performed
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
Performer
The people who performed the procedure
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
role |
The role the actor was in |
actor |
The reference to the practitioner |
on_behalf_of |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Identifiers assigned to this order |
definition[] |
Protocol or definition |
based_on[] |
What request fulfills |
replaces[] |
What request replaces |
requisition |
Composite Request ID |
status |
draft | active | suspended | completed | entered-in-error | cancelled |
intent |
proposal | plan | order + |
priority |
routine | urgent | asap | stat |
do_not_perform |
True if procedure should not be performed |
category[] |
Classification of procedure |
code |
What is being requested/ordered |
subject |
Individual the service is ordered for |
context |
Encounter or Episode during which request was created |
occurrence |
|
as_needed |
|
authored_on |
Date request signed |
requester |
|
performer_type |
Performer role |
performer |
Requested perfomer |
reason_code[] |
Explanation/Justification for test |
reason_reference[] |
Explanation/Justification for test |
supporting_info[] |
Additional clinical information |
specimen[] |
Procedure Samples |
body_site[] |
Location on Body |
note[] |
Comments |
relevant_history[] |
Request provenance |
AsNeeded
Preconditions for procedure or diagnostic
| Fields | |
|---|---|
Union field
|
|
boolean |
|
codeable_concept |
|
Occurrence
When procedure should occur
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
timing |
|
Requester
Who/what is requesting procedure or diagnostic
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
agent |
Individual making the request |
on_behalf_of |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier |
status |
active | cancelled | draft | entered-in-error |
action |
cancel | poll | reprocess | status |
target |
Party which is the target of the request |
created |
Creation date |
provider |
Responsible practitioner |
organization |
Responsible organization |
request |
Reference to the Request resource |
response |
Reference to the Response resource |
nullify |
Remove history |
reference |
Reference number/string |
item[] |
|
include[] |
Resource type(s) to include |
exclude[] |
Resource type(s) to exclude |
period |
Selection period |
Items
Items to re-adjudicate
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
sequence_link_id |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier |
status |
active | cancelled | draft | entered-in-error |
created |
Creation date |
organization |
Authoring Organization |
request |
Request reference |
outcome |
Processing outcome |
disposition |
Disposition Message |
request_provider |
Responsible Practitioner |
request_organization |
Responsible organization |
form |
Printed Form Identifier |
process_note[] |
|
error[] |
Error code |
communication_request[] |
Request for additional information |
ProcessNote
Processing comments or additional requirements
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
display | print | printoper |
text |
Comment on the processing |
PropertyRepresentationCode
How a property is represented when serialized. See http://hl7.org/fhir/ValueSet/property-representation
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
target[] |
Target Reference(s) (usually version specific) |
period |
When the activity occurred |
recorded |
When the activity was recorded / updated |
policy[] |
Policy or plan the activity was defined by |
location |
Where the activity occurred, if relevant |
reason[] |
Reason the activity is occurring |
activity |
Activity that occurred |
agent[] |
|
entity[] |
|
signature[] |
Signature on target |
Agent
Actor involved
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
role[] |
What the agents role was |
who |
|
on_behalf_of |
|
related_agent_type |
Type of relationship between agents |
OnBehalfOf
Who the agent is representing
| Fields | |
|---|---|
Union field
|
|
uri |
|
reference |
|
Who
Who participated
| Fields | |
|---|---|
Union field
|
|
uri |
|
reference |
|
Entity
An entity used in this activity
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
role |
derivation | revision | quotation | source | removal |
what |
|
agent[] |
Entity is attributed to this agent |
What
Identity of entity
| Fields | |
|---|---|
Union field
|
|
uri |
|
reference |
|
identifier |
|
ProvenanceEntityRoleCode
How an entity was used in an activity. See http://hl7.org/fhir/ValueSet/provenance-entity-role
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
extension[] |
|
Value
| Enums | |
|---|---|
INVALID_UNINITIALIZED |
|
DRAFT |
|
ACTIVE |
|
RETIRED |
|
UNKNOWN |
|
QualityTypeCode
Type for quality report See http://hl7.org/fhir/ValueSet/quality-type
| Fields | |
|---|---|
value |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
value |
Numerical value (with implicit precision) |
comparator |
< | <= | >= | > - how to understand the value |
unit |
Unit representation |
system |
System that defines coded unit form |
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 |
|
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this questionnaire (globally unique) |
identifier[] |
Additional identifier for the questionnaire |
version |
Business version of the questionnaire |
name |
Name for this questionnaire (computer friendly) |
title |
Name for this questionnaire (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
description |
Natural language description of the questionnaire |
purpose |
Why this questionnaire is defined |
approval_date |
When the questionnaire was approved by publisher |
last_review_date |
When the questionnaire was last reviewed |
effective_period |
When the questionnaire is expected to be used |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for questionnaire (if applicable) |
contact[] |
Contact details for the publisher |
copyright |
Use and/or publishing restrictions |
code[] |
Concept that represents the overall questionnaire |
subject_type[] |
Resource that can be subject of QuestionnaireResponse |
item[] |
|
Item
Questions and sections within the Questionnaire
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
link_id |
Unique id for item in questionnaire |
definition |
ElementDefinition - details for the item |
code[] |
Corresponding concept for this item in a terminology |
prefix |
E.g. "1(a)", "2.5.3" |
text |
Primary text for the item |
type |
group | display | boolean | decimal | integer | date | dateTime + |
enable_when[] |
|
required |
Whether the item must be included in data results |
repeats |
Whether the item may repeat |
read_only |
Don't allow human editing |
max_length |
No more than this many characters |
options |
Valueset containing permitted answers |
option[] |
|
initial |
|
item[] |
Nested questionnaire items |
EnableWhen
Only allow data when
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
question |
Question that determines whether item is enabled |
has_answer_value |
Enable when answered or not |
answer |
|
Answer
Value question must have
| Fields | |
|---|---|
Union field
|
|
boolean |
|
decimal |
|
integer |
|
date |
|
date_time |
|
time |
|
string_value |
|
uri |
|
attachment |
|
coding |
|
quantity |
|
reference |
|
Initial
Default value when item is first rendered
| Fields | |
|---|---|
Union field
|
|
boolean |
|
decimal |
|
integer |
|
date |
|
date_time |
|
time |
|
string_value |
|
uri |
|
attachment |
|
coding |
|
quantity |
|
reference |
|
Option
Permitted answer
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
value |
|
Value
Answer value
| Fields | |
|---|---|
Union field
|
|
integer |
|
date |
|
time |
|
string_value |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Unique id for this set of answers |
based_on[] |
Request fulfilled by this QuestionnaireResponse |
parent[] |
Part of this action |
questionnaire |
Form being answered |
status |
in-progress | completed | amended | entered-in-error | stopped |
subject |
The subject of the questions |
context |
Encounter or Episode during which questionnaire was completed |
authored |
Date the answers were gathered |
author |
Person who received and recorded the answers |
source |
The person who answered the questions |
item[] |
|
Item
Groups and questions
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
link_id |
Pointer to specific item from Questionnaire |
definition |
ElementDefinition - details for the item |
text |
Name for group or question text |
subject |
The subject this group's answers are about |
answer[] |
|
item[] |
Nested questionnaire response items |
Answer
The response(s) to the question
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
value |
|
item[] |
Nested groups and questions |
Value
Single-valued answer to the question
| Fields | |
|---|---|
Union field
|
|
boolean |
|
decimal |
|
integer |
|
date |
|
date_time |
|
time |
|
string_value |
|
uri |
|
attachment |
|
coding |
|
quantity |
|
reference |
|
QuestionnaireResponseStatusCode
Lifecycle status of the questionnaire response. See http://hl7.org/fhir/ValueSet/questionnaire-answers-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
low |
Low limit |
high |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
numerator |
Numerator value |
denominator |
Denominator value |
Reference
A reference from one resource to another See https://www.hl7.org/fhir/datatypes.html#Reference
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
identifier |
Logical reference, when literal reference is not known |
display |
Text alternative for the resource |
Union field reference. Literal reference, Relative, internal or absolute URL reference can be only one of the following: |
|
uri |
Absolute URIs are untyped. |
fragment |
Fragments (internal references) are untyped, and represented here without the leading '#'. |
account_id |
Typed relative urls are represented here. |
activity_definition_id |
|
adverse_event_id |
|
allergy_intolerance_id |
|
appointment_id |
|
appointment_response_id |
|
audit_event_id |
|
basic_id |
|
binary_id |
|
body_site_id |
|
bundle_id |
|
capability_statement_id |
|
care_plan_id |
|
care_team_id |
|
charge_item_id |
|
claim_id |
|
claim_response_id |
|
clinical_impression_id |
|
code_system_id |
|
communication_id |
|
communication_request_id |
|
compartment_definition_id |
|
composition_id |
|
concept_map_id |
|
condition_id |
|
consent_id |
|
contract_id |
|
coverage_id |
|
data_element_id |
|
detected_issue_id |
|
device_id |
|
device_component_id |
|
device_metric_id |
|
device_request_id |
|
device_use_statement_id |
|
diagnostic_report_id |
|
document_manifest_id |
|
document_reference_id |
|
eligibility_request_id |
|
eligibility_response_id |
|
encounter_id |
|
endpoint_id |
|
enrollment_request_id |
|
enrollment_response_id |
|
episode_of_care_id |
|
expansion_profile_id |
|
explanation_of_benefit_id |
|
family_member_history_id |
|
flag_id |
|
goal_id |
|
graph_definition_id |
|
group_id |
|
guidance_response_id |
|
healthcare_service_id |
|
imaging_manifest_id |
|
imaging_study_id |
|
immunization_id |
|
immunization_recommendation_id |
|
implementation_guide_id |
|
library_id |
|
linkage_id |
|
list_id |
|
location_id |
|
measure_id |
|
measure_report_id |
|
media_id |
|
medication_id |
|
medication_administration_id |
|
medication_dispense_id |
|
medication_request_id |
|
medication_statement_id |
|
message_definition_id |
|
message_header_id |
|
naming_system_id |
|
nutrition_order_id |
|
observation_id |
|
operation_definition_id |
|
operation_outcome_id |
|
organization_id |
|
parameters_id |
|
patient_id |
|
payment_notice_id |
|
payment_reconciliation_id |
|
person_id |
|
plan_definition_id |
|
practitioner_id |
|
practitioner_role_id |
|
procedure_id |
|
procedure_request_id |
|
process_request_id |
|
process_response_id |
|
provenance_id |
|
questionnaire_id |
|
questionnaire_response_id |
|
referral_request_id |
|
related_person_id |
|
request_group_id |
|
research_study_id |
|
research_subject_id |
|
risk_assessment_id |
|
schedule_id |
|
search_parameter_id |
|
sequence_id |
|
service_definition_id |
|
slot_id |
|
specimen_id |
|
structure_definition_id |
|
structure_map_id |
|
subscription_id |
|
substance_id |
|
supply_delivery_id |
|
supply_request_id |
|
task_id |
|
test_report_id |
|
test_script_id |
|
value_set_id |
|
vision_prescription_id |
|
ReferenceHandlingPolicyCode
A set of flags that defines how references are supported. See http://hl7.org/fhir/ValueSet/reference-handling-policy
| Fields | |
|---|---|
value |
|
id |
|
extension[] |
|
Value
| Enums | |
|---|---|
INVALID_UNINITIALIZED |
|
LITERAL |
|
LOGICAL |
|
RESOLVES |
|
ENFORCED |
|
LOCAL |
|
ReferenceId
| Fields | |
|---|---|
value |
Primitive value for id |
history |
History version, if present. |
id |
xml:id (or equivalent in JSON) |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business identifier |
definition[] |
Instantiates protocol or definition |
based_on[] |
Request fulfilled by this request |
replaces[] |
Request(s) replaced by this request |
group_identifier |
Composite request this is part of |
status |
draft | active | suspended | cancelled | completed | entered-in-error | unknown |
intent |
proposal | plan | order |
type |
Referral/Transition of care request type |
priority |
Urgency of referral / transfer of care request |
service_requested[] |
Actions requested as part of the referral |
subject |
Patient referred to care or transfer |
context |
Originating encounter |
occurrence |
|
authored_on |
Date of creation/activation |
requester |
|
specialty |
The clinical specialty (discipline) that the referral is requested for |
recipient[] |
Receiver of referral / transfer of care request |
reason_code[] |
Reason for referral / transfer of care request |
reason_reference[] |
Why is service needed? |
description |
A textual description of the referral |
supporting_info[] |
Additonal information to support referral or transfer of care request |
note[] |
Comments made about referral request |
relevant_history[] |
Key events in history of request |
Occurrence
When the service(s) requested in the referral should occur
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
Requester
Who/what is requesting service
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
agent |
Individual making the request |
on_behalf_of |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
type |
documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of |
display |
Brief description of the related artifact |
citation |
Bibliographic citation for the artifact |
url |
Where the artifact can be accessed |
document |
What document is being referenced |
resource |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
A human identifier for this person |
active |
Whether this related person's record is in active use |
patient |
The patient this person is related to |
relationship |
The nature of the relationship |
name[] |
A name associated with the person |
telecom[] |
A contact detail for the person |
gender |
male | female | other | unknown |
birth_date |
The date on which the related person was born |
address[] |
Address where the related person can be contacted or visited |
photo[] |
Image of the person |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business identifier |
definition[] |
Instantiates protocol or definition |
based_on[] |
Fulfills plan, proposal, or order |
replaces[] |
Request(s) replaced by this request |
group_identifier |
Composite request this is part of |
status |
draft | active | suspended | cancelled | completed | entered-in-error | unknown |
intent |
proposal | plan | order |
priority |
routine | urgent | asap | stat |
subject |
Who the request group is about |
context |
Encounter or Episode for the request group |
authored_on |
When the request group was authored |
author |
Device or practitioner that authored the request group |
reason |
|
note[] |
Additional notes about the response |
action[] |
|
Action
Proposed actions, if any
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
label |
User-visible label for the action (e.g. 1. or A.) |
title |
User-visible title |
description |
Short description of the action |
text_equivalent |
Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
code[] |
Code representing the meaning of the action or sub-actions |
documentation[] |
Supporting documentation for the intended performer of the action |
condition[] |
|
related_action[] |
|
timing |
|
participant[] |
Who should perform the action |
type |
create | update | remove | fire-event |
grouping_behavior |
visual-group | logical-group | sentence-group |
selection_behavior |
any | all | all-or-none | exactly-one | at-most-one | one-or-more |
required_behavior |
must | could | must-unless-documented |
precheck_behavior |
yes | no |
cardinality_behavior |
single | multiple |
resource |
The target of the action |
action[] |
Sub action |
Condition
Whether or not the action is applicable
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
kind |
applicability | start | stop |
description |
Natural language description of the condition |
language |
Language of the expression |
expression |
Boolean-valued expression |
RelatedAction
Relationship to another action
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
action_id |
What action this is related to |
relationship |
before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end |
offset |
|
Offset
Time offset for the relationship
| Fields | |
|---|---|
Union field
|
|
duration |
|
range |
|
TimingType
When the action should take place
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
duration |
|
range |
|
timing_value |
|
Reason
Reason for the request group
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
RequestIntentCode
Codes indicating the degree of authority/intentionality associated with a request See http://hl7.org/fhir/ValueSet/request-intent
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business Identifier for study |
title |
Name for this study |
protocol[] |
Steps followed in executing study |
part_of[] |
Part of larger study |
status |
draft | in-progress | suspended | stopped | completed | entered-in-error |
category[] |
Classifications for the study |
focus[] |
Drugs, devices, conditions, etc. under study |
contact[] |
Contact details for the study |
related_artifact[] |
References and dependencies |
keyword[] |
Used to search for the study |
jurisdiction[] |
Geographic region(s) for study |
description |
What this is study doing |
enrollment[] |
Inclusion & exclusion criteria |
period |
When the study began and ended |
sponsor |
Organization responsible for the study |
principal_investigator |
The individual responsible for the study |
site[] |
Location involved in study execution |
reason_stopped |
Reason for terminating study early |
note[] |
Comments made about the event |
arm[] |
|
Arm
Defined path through the study for a subject
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Label for study arm |
code |
Categorization of study arm |
description |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Business Identifier for research subject |
status |
candidate | enrolled | active | suspended | withdrawn | completed |
period |
Start and end of participation |
study |
Study subject is part of |
individual |
Who is part of study |
assigned_arm |
What path should be followed |
actual_arm |
What path was followed |
consent |
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Unique identifier for the assessment |
based_on |
Request fulfilled by this assessment |
parent |
Part of this occurrence |
status |
registered | preliminary | final | amended + |
method |
Evaluation mechanism |
code |
Type of assessment |
subject |
Who/what does assessment apply to? |
context |
Where was assessment performed? |
occurrence |
|
condition |
Condition assessed |
performer |
Who did assessment? |
reason |
|
basis[] |
Information used in assessment |
prediction[] |
|
mitigation |
How to reduce risk |
comment |
Comments on the risk assessment |
Occurrence
When was assessment made?
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
Prediction
Outcome predicted
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
outcome |
Possible outcome for the subject |
probability |
|
qualitative_risk |
Likelihood of specified outcome as a qualitative value |
relative_risk |
Relative likelihood |
when |
|
rationale |
Explanation of prediction |
Probability
Likelihood of specified outcome
| Fields | |
|---|---|
Union field
|
|
decimal |
|
range |
|
When
Timeframe or age range
| Fields | |
|---|---|
Union field
|
|
period |
|
range |
|
Reason
Why the assessment was necessary?
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
origin |
Zero value and units |
period |
Number of milliseconds between samples |
factor |
Multiply data by this before adding to origin |
lower_limit |
Lower limit of detection |
upper_limit |
Upper limit of detection |
dimensions |
Number of sample points at each time point |
data |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Ids for this item |
active |
Whether this schedule is in active use |
service_category |
A broad categorisation of the service that is to be performed during this appointment |
service_type[] |
The specific service that is to be performed during this appointment |
specialty[] |
The specialty of a practitioner that would be required to perform the service requested in this appointment |
actor[] |
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 |
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 |
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this search parameter (globally unique) |
version |
Business version of the search parameter |
name |
Name for this search parameter (computer friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for search parameter (if applicable) |
purpose |
Why this search parameter is defined |
code |
Code used in URL |
base[] |
The resource type(s) this search parameter applies to |
type |
number | date | string | token | reference | composite | quantity | uri |
derived_from |
Original Definition for the search parameter |
description |
Natural language description of the search parameter |
expression |
FHIRPath expression that extracts the values |
xpath |
XPath that extracts the values |
xpath_usage |
normal | phonetic | nearby | distance | other |
target[] |
Types of resource (if a resource reference) |
comparator[] |
eq | ne | gt | lt | ge | le | sa | eb | ap |
modifier[] |
missing | exact | contains | not | text | in | not-in | below | above | type |
chain[] |
Chained names supported |
component[] |
|
Component
For Composite resources to define the parts
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
definition |
Defines how the part works |
expression |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Unique ID for this particular sequence. This is a FHIR-defined id |
type |
aa | dna | rna |
coordinate_system |
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 |
Who and/or what this is about |
specimen |
Specimen used for sequencing |
device |
The method for sequencing |
performer |
Who should be responsible for test result |
quantity |
The number of copies of the seqeunce of interest. (RNASeq) |
reference_seq |
|
variant[] |
|
observed_seq |
Sequence that was observed |
quality[] |
|
read_coverage |
Average number of reads representing a given nucleotide in the reconstructed sequence |
repository[] |
|
pointer[] |
Pointer to next atomic sequence |
Quality
An set of value as quality of sequence
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
indel | snp | unknown |
standard_sequence |
Standard sequence for comparison |
start |
Start position of the sequence |
end |
End position of the sequence |
score |
Quality score for the comparison |
method |
Method to get quality |
truth_tp |
True positives from the perspective of the truth data |
query_tp |
True positives from the perspective of the query data |
truth_fn |
False negatives |
query_fp |
False positives |
gt_fp |
False positives where the non-REF alleles in the Truth and Query Call Sets match |
precision |
Precision of comparison |
recall |
Recall of comparison |
f_score |
F-score |
ReferenceSeq
A sequence used as reference
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
chromosome |
Chromosome containing genetic finding |
genome_build |
The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' |
reference_seq_id |
Reference identifier |
reference_seq_pointer |
A Pointer to another Sequence entity as reference sequence |
reference_seq_string |
A string to represent reference sequence |
strand |
Directionality of DNA ( +1/-1) |
window_start |
Start position of the window on the reference sequence |
window_end |
End position of the window on the reference sequence |
Repository
External repository which contains detailed report related with observedSeq in this resource
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
directlink | openapi | login | oauth | other |
url |
URI of the repository |
name |
Repository's name |
dataset_id |
Id of the dataset that used to call for dataset in repository |
variantset_id |
Id of the variantset that used to call for variantset in repository |
readset_id |
Id of the read |
Variant
Variant in sequence
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
start |
Start position of the variant on the reference sequence |
end |
End position of the variant on the reference sequence |
observed_allele |
Allele that was observed |
reference_allele |
Allele in the reference sequence |
cigar |
Extended CIGAR string for aligning the sequence with reference bases |
variant_pointer |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this service definition (globally unique) |
identifier[] |
Additional identifier for the service definition |
version |
Business version of the service definition |
name |
Name for this service definition (computer friendly) |
title |
Name for this service definition (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
description |
Natural language description of the service definition |
purpose |
Why this service definition is defined |
usage |
Describes the clinical usage of the module |
approval_date |
When the service definition was approved by publisher |
last_review_date |
When the service definition was last reviewed |
effective_period |
When the service definition is expected to be used |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for service definition (if applicable) |
topic[] |
E.g. Education, Treatment, Assessment, etc |
contributor[] |
A content contributor |
contact[] |
Contact details for the publisher |
copyright |
Use and/or publishing restrictions |
related_artifact[] |
Additional documentation, citations, etc |
trigger[] |
"when" the module should be invoked |
data_requirement[] |
What data is used by the module |
operation_definition |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
type[] |
Indication of the reason the entity signed the object(s) |
when |
When the signature was created |
who |
|
on_behalf_of |
|
content_type |
The technical format of the signature |
blob |
The actual signature content (XML DigSig. JWT, picture, etc.) |
OnBehalfOf
The party represented
| Fields | |
|---|---|
Union field
|
|
uri |
|
reference |
|
Who
Who signed
| Fields | |
|---|---|
Union field
|
|
uri |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
value |
Numerical value (with implicit precision) |
unit |
Unit representation |
system |
System that defines coded unit form |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Ids for this item |
service_category |
A broad categorisation of the service that is to be performed during this appointment |
service_type[] |
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[] |
The specialty of a practitioner that would be required to perform the service requested in this appointment |
appointment_type |
The style of appointment or patient that may be booked in the slot (not service type) |
schedule |
The schedule resource that this slot defines an interval of status information |
status |
busy | free | busy-unavailable | busy-tentative | entered-in-error |
start |
Date/Time that the slot is to begin |
end |
Date/Time that the slot is to conclude |
overbooked |
This slot has already been overbooked, appointments are unlikely to be accepted for this time |
comment |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
External Identifier |
accession_identifier |
Identifier assigned by the lab |
status |
available | unavailable | unsatisfactory | entered-in-error |
type |
Kind of material that forms the specimen |
subject |
Where the specimen came from. This may be from the patient(s) or from the environment or a device |
received_time |
The time when specimen was received for processing |
parent[] |
Specimen from which this specimen originated |
request[] |
Why the specimen was collected |
collection |
|
processing[] |
|
container[] |
|
note[] |
Comments |
Collection
Collection details
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
collector |
Who collected the specimen |
collected |
|
quantity |
The quantity of specimen collected |
method |
Technique used to perform collection |
body_site |
Anatomical collection site |
Collected
Collection time
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
Container
Direct container of specimen (tube/slide, etc.)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Id for the container |
description |
Textual description of the container |
type |
Kind of container directly associated with specimen |
capacity |
Container volume or size |
specimen_quantity |
Quantity of specimen within container |
additive |
|
Additive
Additive associated with container
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Processing
Processing and processing step details
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
description |
Textual description of procedure |
procedure |
Indicates the treatment step applied to the specimen |
additive[] |
Material used in the processing step |
time |
|
Time
Date and time of specimen processing
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
SpecimenStatusCode
Codes providing the status/availability of a specimen. See http://hl7.org/fhir/ValueSet/specimen-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
Primitive value for string |
id |
xml:id (or equivalent in JSON) |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this structure definition (globally unique) |
identifier[] |
Additional identifier for the structure definition |
version |
Business version of the structure definition |
name |
Name for this structure definition (computer friendly) |
title |
Name for this structure definition (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the structure definition |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for structure definition (if applicable) |
purpose |
Why this structure definition is defined |
copyright |
Use and/or publishing restrictions |
keyword[] |
Assist with indexing and finding |
fhir_version |
FHIR Version this StructureDefinition targets |
mapping[] |
|
kind |
primitive-type | complex-type | resource | logical |
abstract |
Whether the structure is abstract |
context_type |
resource | datatype | extension |
context[] |
Where the extension can be used in instances |
context_invariant[] |
FHIRPath invariants - when the extension can be used |
type |
Type defined or constrained by this structure |
base_definition |
Definition that this type is constrained/specialized from |
derivation |
specialization | constraint - How relates to base definition |
snapshot |
|
differential |
|
Differential
Differential view of the structure
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
element[] |
Definition of elements in the resource (if no StructureDefinition) |
Mapping
External specification that the content is mapped to
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identity |
Internal id when this mapping is used |
uri |
Identifies what this mapping refers to |
name |
Names what this mapping refers to |
comment |
Versions, Issues, Scope limitations etc. |
Snapshot
Snapshot view of the structure
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
element[] |
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this structure map (globally unique) |
identifier[] |
Additional identifier for the structure map |
version |
Business version of the structure map |
name |
Name for this structure map (computer friendly) |
title |
Name for this structure map (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the structure map |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for structure map (if applicable) |
purpose |
Why this structure map is defined |
copyright |
Use and/or publishing restrictions |
structure[] |
|
import[] |
Other maps used by this map (canonical URLs) |
group[] |
|
Group
Named sections for reader convenience
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Human-readable label |
extends |
Another group that this group adds rules to |
type_mode |
none | types | type-and-types |
documentation |
Additional description/explaination for group |
input[] |
|
rule[] |
|
Input
Named instance provided when invoking the map
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name for this instance of data |
type |
Type for this instance of data |
mode |
source | target |
documentation |
Documentation for this instance of data |
Rule
Transform Rule from source to target
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name of the rule for internal references |
source[] |
|
target[] |
|
rule[] |
Rules contained in this rule |
dependent[] |
|
documentation |
Documentation for this instance of data |
Dependent
Which other rules to apply in the context of this rule
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name of a rule or group to apply |
variable[] |
Variable to pass to the rule or group |
Source
Source inputs to the mapping
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
context |
Type or variable this rule applies to |
min |
Specified minimum cardinality |
max |
Specified maximum cardinality (number or *) |
type |
Rule only applies if source has this type |
default_value |
|
element |
Optional field for this source |
list_mode |
first | not_first | last | not_last | only_one |
variable |
Named context for field, if a field is specified |
condition |
FHIRPath expression - must be true or the rule does not apply |
check |
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
|
|
base64_binary |
|
boolean |
|
code |
|
date |
|
date_time |
|
decimal |
|
id |
|
instant |
|
integer |
|
markdown |
|
oid |
|
positive_int |
|
string_value |
|
time |
|
unsigned_int |
|
uri |
|
address |
|
age |
|
annotation |
|
attachment |
|
codeable_concept |
|
coding |
|
contact_point |
|
count |
|
distance |
|
duration |
|
human_name |
|
identifier |
|
money |
|
period |
|
quantity |
|
range |
|
ratio |
|
reference |
|
sampled_data |
|
signature |
|
timing |
|
meta |
|
Target
Content to create because of this mapping rule
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
context |
Type or variable this rule applies to |
context_type |
type | variable |
element |
Field to create in the context |
variable |
Named context for field, if desired, and a field is specified |
list_mode[] |
first | share | last | collate |
list_rule_id |
Internal rule reference for shared list items |
transform |
create | copy + |
parameter[] |
|
Parameter
Parameters to the transform
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
value |
|
Value
Parameter value - variable or literal
| Fields | |
|---|---|
Union field
|
|
id |
|
string_value |
|
boolean |
|
integer |
|
decimal |
|
Structure
Structure Definition used by this map
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Canonical URL for structure definition |
mode |
source | queried | target | produced |
alias |
Name for type in this map |
documentation |
Documentation on use of structure |
StructureMapContextTypeCode
How to interpret the context See http://hl7.org/fhir/ValueSet/map-context-type
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
status |
requested | active | error | off |
contact[] |
Contact details for source (e.g. troubleshooting) |
end |
When to automatically delete the subscription |
reason |
Description of why this subscription was created |
criteria |
Rule for server push criteria |
error |
Latest error note |
channel |
|
tag[] |
A tag to add to matching resources |
Channel
The channel on which to report matches to the criteria
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
rest-hook | websocket | email | sms | message |
endpoint |
Where the channel points to |
payload |
Mimetype to send, or omit for no payload |
header[] |
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Unique identifier |
status |
active | inactive | entered-in-error |
category[] |
What class/type of substance this is |
code |
What substance this is |
description |
Textual description of the substance, comments |
instance[] |
|
ingredient[] |
|
Ingredient
Composition information about the substance
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
quantity |
Optional amount (concentration) |
substance |
|
SubstanceType
A component of the substance
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Instance
If this describes a specific package/container of the substance
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Identifier of the package/container |
expiry |
When no longer valid to use |
quantity |
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
External identifier |
based_on[] |
Fulfills plan, proposal or order |
part_of[] |
Part of referenced event |
status |
in-progress | completed | abandoned | entered-in-error |
patient |
Patient for whom the item is supplied |
type |
Category of dispense event |
supplied_item |
|
occurrence |
|
supplier |
Dispenser |
destination |
Where the Supply was sent |
receiver[] |
Who collected the Supply |
Occurrence
When event occurred
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
timing |
|
SuppliedItem
The item that is delivered or supplied
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
quantity |
Amount dispensed |
item |
|
Item
Medication, Substance, or Device supplied
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
SupplyDeliveryStatusCode
Status of the supply delivery. See http://hl7.org/fhir/ValueSet/supplydelivery-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Unique identifier |
status |
draft | active | suspended + |
category |
The kind of supply (central, non-stock, etc.) |
priority |
routine | urgent | asap | stat |
ordered_item |
|
occurrence |
|
authored_on |
When the request was made |
requester |
|
supplier[] |
Who is intended to fulfill the request |
reason |
|
deliver_from |
The origin of the supply |
deliver_to |
The destination of the supply |
Occurrence
When the request should be fulfilled
| Fields | |
|---|---|
Union field
|
|
date_time |
|
period |
|
timing |
|
OrderedItem
The item being requested
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
quantity |
The requested amount of the item indicated |
item |
|
Item
Medication, Substance, or Device requested to be supplied
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Reason
Why the supply item was requested
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
reference |
|
Requester
Who/what is requesting service
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
agent |
Individual making the request |
on_behalf_of |
Organization agent is acting for |
SupplyRequestStatusCode
Status of the supply request See http://hl7.org/fhir/ValueSet/supplyrequest-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Task Instance Identifier |
definition |
|
based_on[] |
Request fulfilled by this task |
group_identifier |
Requisition or grouper id |
part_of[] |
Composite task |
status |
draft | requested | received | accepted | + |
status_reason |
Reason for current status |
business_status |
E.g. "Specimen collected", "IV prepped" |
intent |
proposal | plan | order + |
priority |
normal | urgent | asap | stat |
code |
Task Type |
description |
Human-readable explanation of task |
focus |
What task is acting on |
for_value |
Beneficiary of the Task |
context |
Healthcare event during which this task originated |
execution_period |
Start and end time of execution |
authored_on |
Task Creation Date |
last_modified |
Task Last Modified Date |
requester |
|
performer_type[] |
requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer |
owner |
Responsible individual |
reason |
Why task is needed |
note[] |
Comments made about the task |
relevant_history[] |
Key events in history of the Task |
restriction |
|
input[] |
|
output[] |
|
Definition
Formal definition of task
| Fields | |
|---|---|
Union field
|
|
uri |
|
reference |
|
Output
Information produced as part of task
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Label for output |
value |
|
Value
Result of output
| Fields | |
|---|---|
Union field
|
|
base64_binary |
|
boolean |
|
code |
|
date |
|
date_time |
|
decimal |
|
id |
|
instant |
|
integer |
|
markdown |
|
oid |
|
positive_int |
|
string_value |
|
time |
|
unsigned_int |
|
uri |
|
address |
|
age |
|
annotation |
|
attachment |
|
codeable_concept |
|
coding |
|
contact_point |
|
count |
|
distance |
|
duration |
|
human_name |
|
identifier |
|
money |
|
period |
|
quantity |
|
range |
|
ratio |
|
reference |
|
sampled_data |
|
signature |
|
timing |
|
meta |
|
Parameter
Information used to perform task
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
Label for the input |
value |
|
Value
Content to use in performing the task
| Fields | |
|---|---|
Union field
|
|
base64_binary |
|
boolean |
|
code |
|
date |
|
date_time |
|
decimal |
|
id |
|
instant |
|
integer |
|
markdown |
|
oid |
|
positive_int |
|
string_value |
|
time |
|
unsigned_int |
|
uri |
|
address |
|
age |
|
annotation |
|
attachment |
|
codeable_concept |
|
coding |
|
contact_point |
|
count |
|
distance |
|
duration |
|
human_name |
|
identifier |
|
money |
|
period |
|
quantity |
|
range |
|
ratio |
|
reference |
|
sampled_data |
|
signature |
|
timing |
|
meta |
|
Requester
Who is asking for task to be done
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
agent |
Individual asking for task |
on_behalf_of |
Organization individual is acting for |
Restriction
Constraints on fulfillment tasks
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
repetitions |
How many times to repeat |
period |
When fulfillment sought |
recipient[] |
For whom is fulfillment sought? |
TaskStatusCode
The current status of the task. See http://hl7.org/fhir/ValueSet/task-status
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
External identifier |
name |
Informal name of the executed TestScript |
status |
completed | in-progress | waiting | stopped | entered-in-error |
test_script |
Reference to the version-specific TestScript that was executed to produce this TestReport |
result |
pass | fail | pending |
score |
The final score (percentage of tests passed) resulting from the execution of the TestScript |
tester |
Name of the tester producing this report (Organization or individual) |
issued |
When the TestScript was executed and this TestReport was generated |
participant[] |
|
setup |
|
test[] |
|
teardown |
|
Participant
A participant in the test execution, either the execution engine, a client, or a server
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
test-engine | client | server |
uri |
The uri of the participant. An absolute URL is preferred |
display |
The display name of the participant |
Setup
The results of the series of required setup operations before the tests were executed
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
action[] |
|
SetupAction
A setup operation or assert that was executed
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
operation |
|
assert_value |
|
Assert
The assertion to perform
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
result |
pass | skip | fail | warning | error |
message |
A message associated with the result |
detail |
A link to further details on the result |
Operation
The operation to perform
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
result |
pass | skip | fail | warning | error |
message |
A message associated with the result |
detail |
A link to further details on the result |
Teardown
The results of running the series of required clean up steps
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
action[] |
|
TeardownAction
One or more teardown operations performed
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
operation |
The teardown operation performed |
Test
A test executed from the test script
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Tracking/logging name of this test |
description |
Tracking/reporting short description of the test |
action[] |
|
TestAction
A test operation or assert that was performed
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
operation |
The operation performed |
assert_value |
The assertion performed |
TestReportActionResultCode
The results of executing an action. See http://hl7.org/fhir/ValueSet/report-action-result-codes
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this test script (globally unique) |
identifier |
Additional identifier for the test script |
version |
Business version of the test script |
name |
Name for this test script (computer friendly) |
title |
Name for this test script (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the test script |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for test script (if applicable) |
purpose |
Why this test script is defined |
copyright |
Use and/or publishing restrictions |
origin[] |
|
destination[] |
|
metadata |
|
fixture[] |
|
profile[] |
Reference of the validation profile |
variable[] |
|
rule[] |
|
ruleset[] |
|
setup |
|
test[] |
|
teardown |
|
Destination
An abstract server representing a destination or receiver in a message exchange
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
index |
The index of the abstract destination server starting at 1 |
profile |
FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor |
Fixture
Fixture in the test script - by reference (uri)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
autocreate |
Whether or not to implicitly create the fixture during setup |
autodelete |
Whether or not to implicitly delete the fixture during teardown |
resource |
Reference of the resource |
Metadata
Required capability that is assumed to function correctly on the FHIR server being tested
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
link[] |
|
capability[] |
|
Capability
Capabilities that are assumed to function correctly on the FHIR server being tested
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
required |
Are the capabilities required? |
validated |
Are the capabilities validated? |
description |
The expected capabilities of the server |
origin[] |
Which origin server these requirements apply to |
destination |
Which server these requirements apply to |
link[] |
Links to the FHIR specification |
capabilities |
Required Capability Statement |
Link
Links to the FHIR specification
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
URL to the specification |
description |
Short description |
Origin
An abstract server representing a client or sender in a message exchange
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
index |
The index of the abstract origin server starting at 1 |
profile |
FHIR-Client | FHIR-SDC-FormFiller |
Rule
Assert rule used within the test script
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
resource |
Assert rule resource reference |
param[] |
|
RuleParam
Rule parameter template
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Parameter name matching external assert rule parameter |
value |
Parameter value defined either explicitly or dynamically |
Ruleset
Assert ruleset used within the test script
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
resource |
Assert ruleset resource reference |
rule[] |
|
RulesetRule
The referenced rule within the ruleset
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
rule_id |
Id of referenced rule within the ruleset |
param[] |
|
RulesetRuleParam
Ruleset rule parameter template
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Parameter name matching external assert ruleset rule parameter |
value |
Parameter value defined either explicitly or dynamically |
Setup
A series of required setup operations before tests are executed
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
action[] |
|
SetupAction
A setup operation or assert to perform
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
operation |
|
assert_value |
|
Assert
The assertion to perform
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
label |
Tracking/logging assertion label |
description |
Tracking/reporting assertion description |
direction |
response | request |
compare_to_source_id |
Id of the source fixture to be evaluated |
compare_to_source_expression |
The fluentpath expression to evaluate against the source fixture |
compare_to_source_path |
XPath or JSONPath expression to evaluate against the source fixture |
content_type |
xml | json | ttl | none |
expression |
The fluentpath expression to be evaluated |
header_field |
HTTP header field name |
minimum_id |
Fixture Id of minimum content resource |
navigation_links |
Perform validation on navigation links? |
operator |
equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval |
path |
XPath or JSONPath expression |
request_method |
delete | get | options | patch | post | put |
request_url |
Request URL comparison value |
resource |
Resource type |
response |
okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable |
response_code |
HTTP response code to test |
rule |
|
ruleset |
|
source_id |
Fixture Id of source expression or headerField |
validate_profile_id |
Profile Id of validation profile reference |
value |
The value to compare to |
warning_only |
Will this assert produce a warning only on error? |
ActionAssertRule
The reference to a TestScript.rule
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
rule_id |
Id of the TestScript.rule |
param[] |
|
ActionAssertRuleParam
Rule parameter template
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Parameter name matching external assert rule parameter |
value |
Parameter value defined either explicitly or dynamically |
ActionAssertRuleset
The reference to a TestScript.ruleset
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
ruleset_id |
Id of the TestScript.ruleset |
rule[] |
|
ActionAssertRulesetRule
The referenced rule within the ruleset
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
rule_id |
Id of referenced rule within the ruleset |
param[] |
|
Param
Rule parameter template
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Parameter name matching external assert ruleset rule parameter |
value |
Parameter value defined either explicitly or dynamically |
Operation
The setup operation to perform
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
type |
The operation code type that will be executed |
resource |
Resource type |
label |
Tracking/logging operation label |
description |
Tracking/reporting operation description |
accept |
xml | json | ttl | none |
content_type |
xml | json | ttl | none |
destination |
Server responding to the request |
encode_request_url |
Whether or not to send the request url in encoded format |
origin |
Server initiating the request |
params |
Explicitly defined path parameters |
request_header[] |
|
request_id |
Fixture Id of mapped request |
response_id |
Fixture Id of mapped response |
source_id |
Fixture Id of body for PUT and POST requests |
target_id |
Id of fixture used for extracting the [id], [type], and [vid] for GET requests |
url |
Request URL |
RequestHeader
Each operation can have one or more header elements
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
field |
HTTP header field name |
value |
HTTP headerfield value |
Teardown
A series of required clean up steps
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
action[] |
|
TeardownAction
One or more teardown operations to perform
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
operation |
The teardown operation to perform |
Test
A test in this script
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Tracking/logging name of this test |
description |
Tracking/reporting short description of the test |
action[] |
|
TestAction
A test operation or assert to perform
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
operation |
The setup operation to perform |
assert_value |
The setup assertion to perform |
Variable
Placeholder for evaluated elements
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Descriptive name for this variable |
default_value |
Default, hard-coded, or user-defined value for this variable |
description |
Natural language description of the variable |
expression |
The fluentpath expression against the fixture body |
header_field |
HTTP header field name for source |
hint |
Hint help text for default value to enter |
path |
XPath or JSONPath against the fixture body |
source_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 |
|
id |
|
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 |
Primitive value for time |
precision |
|
id |
xml:id (or equivalent in JSON) |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
event[] |
When the event occurs |
repeat |
|
code |
BID | TID | QID | AM | PM | QD | QOD | Q4H | Q6H + |
Repeat
When the event is to occur
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
bounds |
|
count |
Number of times to repeat |
count_max |
Maximum number of times to repeat |
duration |
How long when it happens |
duration_max |
How long when it happens (Max) |
duration_unit |
s | min | h | d | wk | mo | a - unit of time (UCUM) |
frequency |
Event occurs frequency times per period |
frequency_max |
Event occurs up to frequencyMax times per period |
period |
Event occurs frequency times per period |
period_max |
Upper limit of period (3-4 hours) |
period_unit |
s | min | h | d | wk | mo | a - unit of time (UCUM) |
day_of_week[] |
mon | tue | wed | thu | fri | sat | sun |
time_of_day[] |
Time of day for action |
when[] |
Regular life events the event is tied to |
offset |
Minutes from event (before or after) |
Bounds
Length/Range of lengths, or (Start and/or end) limits
| Fields | |
|---|---|
Union field
|
|
duration |
|
range |
|
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
type |
named-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended |
event_name |
Triggering event name |
event_timing |
|
event_data |
Triggering data of the event |
EventTiming
Timing of the event
| Fields | |
|---|---|
Union field
|
|
timing |
|
reference |
|
date |
|
date_time |
|
TriggerTypeCode
The type of trigger See http://hl7.org/fhir/ValueSet/trigger-type
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
|
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 |
|
id |
xml:id (or equivalent in JSON) |
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 |
|
id |
|
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 |
Primitive value for unsignedInt |
id |
xml:id (or equivalent in JSON) |
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 |
Primitive value for uri |
id |
xml:id (or equivalent in JSON) |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
code |
Type of context being specified |
value |
|
Value
Value that defines the context
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
quantity |
|
range |
|
UseCode
Complete, proposed, exploratory, other See http://hl7.org/fhir/ValueSet/claim-use
| Fields | |
|---|---|
value |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
url |
Logical URI to reference this value set (globally unique) |
identifier[] |
Additional identifier for the value set |
version |
Business version of the value set |
name |
Name for this value set (computer friendly) |
title |
Name for this value set (human friendly) |
status |
draft | active | retired | unknown |
experimental |
For testing purposes, not real usage |
date |
Date this was last changed |
publisher |
Name of the publisher (organization or individual) |
contact[] |
Contact details for the publisher |
description |
Natural language description of the value set |
use_context[] |
Context the content is intended to support |
jurisdiction[] |
Intended jurisdiction for value set (if applicable) |
immutable |
Indicates whether or not any change to the content logical definition may occur |
purpose |
Why this value set is defined |
copyright |
Use and/or publishing restrictions |
extensible |
Whether this is intended to be used with an extensible binding |
compose |
|
expansion |
|
Compose
Definition of the content of the value set (CLD)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
locked_date |
Fixed date for version-less references (transitive) |
inactive |
Whether inactive codes are in the value set |
include[] |
|
exclude[] |
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 |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
system |
The system the codes come from |
version |
Specific version of the code system referred to |
concept[] |
|
filter[] |
|
value_set[] |
Select only contents included in this value set |
ConceptReference
A concept defined in the system
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
code |
Code or expression from system |
display |
Text to display for this code for this value set in this valueset |
designation[] |
|
Designation
Additional representations for this concept
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
language |
Human language of the designation |
use |
Details how this designation would be used |
value |
The text value for this designation |
Filter
Select codes/concepts by their properties (including relationships)
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
property |
A property defined by the code system |
op |
= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists |
value |
Code from the system, or regex criteria, or boolean value for exists |
Expansion
Used when the value set is "expanded"
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier |
Uniquely identifies this expansion |
timestamp |
Time ValueSet expansion happened |
total |
Total number of codes in the expansion |
offset |
Offset at which this resource starts |
parameter[] |
|
contains[] |
|
Contains
Codes in the value set
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
system |
System value for the code |
abstract |
If user cannot select this entry |
inactive |
If concept is inactive in the code system |
version |
Version in which this code/display is defined |
code |
Code - if blank, this is not a selectable code |
display |
User display for the concept |
designation[] |
Additional representations for this item |
contains[] |
Codes contained under this entry |
Parameter
Parameter that controlled the expansion process
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
name |
Name as assigned by the server |
value |
|
Value
Value of the named parameter
| Fields | |
|---|---|
Union field
|
|
string_value |
|
boolean |
|
integer |
|
decimal |
|
uri |
|
code |
|
VisionBaseCode
A coded concept listing the base codes. See http://hl7.org/fhir/ValueSet/vision-base-codes
| Fields | |
|---|---|
value |
|
id |
|
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 |
|
id |
|
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 |
Logical id of this artifact |
meta |
Metadata about the resource |
implicit_rules |
A set of rules under which this content was created |
language |
Language of the resource content |
text |
Text summary of the resource, for human interpretation |
contained[] |
Contained, inline Resources |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
identifier[] |
Business identifier |
status |
active | cancelled | draft | entered-in-error |
patient |
Who prescription is for |
encounter |
Created during encounter / admission / stay |
date_written |
When prescription was authorized |
prescriber |
Who authorizes the vision product |
reason |
|
dispense[] |
|
Dispense
Vision supply authorization
| Fields | |
|---|---|
id |
xml:id (or equivalent in JSON) |
extension[] |
Additional Content defined by implementations |
modifier_extension[] |
Extensions that cannot be ignored |
product |
Product to be supplied |
eye |
right | left |
sphere |
Lens sphere |
cylinder |
Lens cylinder |
axis |
Lens axis |
prism |
Lens prism |
base |
up | down | in | out |
add |
Lens add |
power |
Contact lens power |
back_curve |
Contact lens back curvature |
diameter |
Contact lens diameter |
duration |
Lens wear duration |
color |
Color required |
brand |
Brand required |
note[] |
Notes for coatings |
Reason
Reason or indication for writing the prescription
| Fields | |
|---|---|
Union field
|
|
codeable_concept |
|
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 |
|
id |
|
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 |
Actual xhtml |
id |
xml:id (or equivalent in JSON) |