---
:name: us_core_patient
:class_name: USCorev311PatientSequence
:version: v3.1.1
:reformatted_version: v311
:resource: Patient
:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
:profile_name: US Core Patient Profile
:profile_version: 3.1.1
:title: Patient
:short_description: Verify support for the server capabilities required by the US
  Core Patient Profile.
:is_delayed: false
:interactions:
- :code: create
  :expectation: MAY
- :code: search-type
  :expectation: SHALL
- :code: read
  :expectation: SHALL
- :code: vread
  :expectation: SHOULD
- :code: update
  :expectation: MAY
- :code: patch
  :expectation: MAY
- :code: delete
  :expectation: MAY
- :code: history-instance
  :expectation: SHOULD
- :code: history-type
  :expectation: MAY
:operations: []
:searches:
- :names:
  - _id
  :expectation: SHALL
  :names_not_must_support_or_mandatory: []
  :must_support_or_mandatory: true
- :names:
  - identifier
  :expectation: SHALL
  :names_not_must_support_or_mandatory: []
  :must_support_or_mandatory: true
- :names:
  - name
  :expectation: SHALL
  :names_not_must_support_or_mandatory: []
  :must_support_or_mandatory: true
- :expectation: SHOULD
  :names:
  - birthdate
  - family
  :names_not_must_support_or_mandatory: []
  :must_support_or_mandatory: true
- :expectation: SHOULD
  :names:
  - family
  - gender
  :names_not_must_support_or_mandatory: []
  :must_support_or_mandatory: true
- :expectation: SHALL
  :names:
  - birthdate
  - name
  :names_not_must_support_or_mandatory: []
  :must_support_or_mandatory: true
- :expectation: SHALL
  :names:
  - gender
  - name
  :names_not_must_support_or_mandatory: []
  :must_support_or_mandatory: true
:search_definitions:
  :_id:
    :paths:
    - id
    :full_paths:
    - Patient.id
    :comparators: {}
    :values: []
    :type: http://hl7.org/fhirpath/System.String
    :contains_multiple: false
    :multiple_or: MAY
  :identifier:
    :paths:
    - identifier
    :full_paths:
    - Patient.identifier
    :comparators: {}
    :values: []
    :type: Identifier
    :contains_multiple: true
    :multiple_or: MAY
  :name:
    :paths:
    - name
    :full_paths:
    - Patient.name
    :comparators: {}
    :values: []
    :type: HumanName
    :contains_multiple: true
    :multiple_or: MAY
  :birthdate:
    :paths:
    - birthDate
    :full_paths:
    - Patient.birthDate
    :comparators:
      :eq: MAY
      :ne: MAY
      :gt: MAY
      :ge: MAY
      :lt: MAY
      :le: MAY
      :sa: MAY
      :eb: MAY
      :ap: MAY
    :values: []
    :type: date
    :contains_multiple: false
    :multiple_or: MAY
  :family:
    :paths:
    - name.family
    :full_paths:
    - Patient.name.family
    :comparators: {}
    :values: []
    :type: string
    :contains_multiple: false
    :multiple_or: MAY
  :gender:
    :paths:
    - gender
    :full_paths:
    - Patient.gender
    :comparators: {}
    :values: []
    :type: code
    :contains_multiple: false
    :multiple_or: MAY
:include_params: []
:revincludes:
- Provenance:target
:required_concepts: []
:must_supports:
  :extensions:
  - :id: Patient.extension:race
    :path: extension
    :url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
  - :id: Patient.extension:ethnicity
    :path: extension
    :url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
  - :id: Patient.extension:birthsex
    :path: extension
    :url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
  :slices: []
  :elements:
  - :path: identifier
  - :path: identifier.system
  - :path: identifier.value
  - :path: name
  - :path: name.family
  - :path: name.given
  - :path: telecom
  - :path: telecom.system
  - :path: telecom.value
  - :path: telecom.use
  - :path: gender
  - :path: birthDate
  - :path: address
  - :path: address.line
  - :path: address.city
  - :path: address.state
  - :path: address.postalCode
  - :path: address.period.end
    :uscdi_only: true
  - :path: communication
  - :path: communication.language
  - :path: name.period.end
    :uscdi_only: true
  - :path: name.use
    :fixed_value: old
    :uscdi_only: true
  - :path: address.use
    :fixed_value: old
    :uscdi_only: true
  :choices:
  - :paths:
    - address.period.end
    - address.use
    :uscdi_only: true
  - :paths:
    - name.period.end
    - name.use
    :uscdi_only: true
:mandatory_elements:
- Patient.identifier
- Patient.identifier.system
- Patient.identifier.value
- Patient.name
- Patient.telecom.system
- Patient.telecom.value
- Patient.gender
- Patient.communication.language
- Patient.link.other
- Patient.link.type
:bindings:
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/ValueSet/identifier-use
  :path: identifier.use
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/ValueSet/name-use
  :path: name.use
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/ValueSet/contact-point-system
  :path: telecom.system
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/ValueSet/contact-point-use
  :path: telecom.use
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/ValueSet/administrative-gender
  :path: gender
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/ValueSet/address-use
  :path: address.use
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/ValueSet/address-type
  :path: address.type
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/ValueSet/administrative-gender
  :path: contact.gender
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/ValueSet/link-type
  :path: link.type
- :type: Coding
  :strength: required
  :system: http://hl7.org/fhir/us/core/ValueSet/omb-race-category
  :path: value
  :extensions:
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
  - ombCategory
- :type: Coding
  :strength: required
  :system: http://hl7.org/fhir/us/core/ValueSet/detailed-race
  :path: value
  :extensions:
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
  - detailed
- :type: Coding
  :strength: required
  :system: http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category
  :path: value
  :extensions:
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
  - ombCategory
- :type: Coding
  :strength: required
  :system: http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
  :path: value
  :extensions:
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
  - detailed
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/us/core/ValueSet/birthsex
  :path: value
  :extensions:
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
:references:
- :path: Patient.identifier.assigner
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Organization
- :path: Patient.contact.organization
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Organization
- :path: Patient.generalPractitioner
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Organization
  - http://hl7.org/fhir/StructureDefinition/Practitioner
  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
- :path: Patient.managingOrganization
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Organization
- :path: Patient.link.other
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Patient
  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
:tests:
- :id: us_core_v311_patient__id_search_test
  :file_name: patient_id_search_test.rb
- :id: us_core_v311_patient_identifier_search_test
  :file_name: patient_identifier_search_test.rb
- :id: us_core_v311_patient_name_search_test
  :file_name: patient_name_search_test.rb
- :id: us_core_v311_patient_birthdate_family_search_test
  :file_name: patient_birthdate_family_search_test.rb
- :id: us_core_v311_patient_family_gender_search_test
  :file_name: patient_family_gender_search_test.rb
- :id: us_core_v311_patient_birthdate_name_search_test
  :file_name: patient_birthdate_name_search_test.rb
- :id: us_core_v311_patient_gender_name_search_test
  :file_name: patient_gender_name_search_test.rb
- :id: us_core_v311_patient_read_test
  :file_name: patient_read_test.rb
- :id: us_core_v311_patient_provenance_revinclude_search_test
  :file_name: patient_provenance_revinclude_search_test.rb
- :id: us_core_v311_patient_validation_test
  :file_name: patient_validation_test.rb
- :id: us_core_v311_patient_must_support_test
  :file_name: patient_must_support_test.rb
:id: us_core_v311_patient
:file_name: patient_group.rb
:delayed_references: []