# Create FHIR r4 patient

Endpoint: POST /site/{siteId}/fhir/patient
Version: 1.0
Security: bearer, bearer

## Path parameters:

  - `siteId` (string, required)
    Site identifier

## Request fields (application/json):

  - `resourceType` (any, required)
    This is a Patient resource
    Enum: "Patient"

  - `id` (string)
    Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive.
    Example: "example-id"

  - `meta` (object)
    The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

  - `meta.id` (string)
    An extension object type #string.
    Example: "example-string"

  - `meta.extension` (array)
    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `meta.versionId` (object)
    An extension object type #id.

  - `meta._versionId` (object)
    An extension object type #Element.

  - `meta.lastUpdated` (object)
    An extension object type #instant.

  - `meta._lastUpdated` (object)
    An extension object type #Element.

  - `meta.source` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `meta._source` (object)
    An extension object type #Element.

  - `meta.profile` (array)
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
    Example: ["http://example.org/Profile"]

  - `meta.security` (array)
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

  - `meta.tag` (array)
    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

  - `implicitRules` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_implicitRules` (object)
    Base definition for all elements in a resource.

  - `language` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_language` (object)
    Base definition for all elements in a resource.

  - `text` (object)
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.

  - `text.status` (any)
    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    Enum: "generated", "extensions", "additional", "empty"

  - `text._status` (object)
    An extension object type #Element.

  - `text.div` (string, required)
    An extension object type #xhtml.
    Example: "<div>Example</div>"

  - `contained` (array)
    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

  - `extension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `extension.url` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `extension._url` (object)
    An extension object type #Element.

  - `extension.valueBase64Binary` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "U2FtcGxl"

  - `extension._valueBase64Binary` (object)
    An extension object type #Element.

  - `extension.valueBoolean` (boolean)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: true

  - `extension._valueBoolean` (object)
    An extension object type #Element.

  - `extension.valueCanonical` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "http://example.org/Profile"

  - `extension._valueCanonical` (object)
    An extension object type #Element.

  - `extension.valueCode` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "sample-code"

  - `extension._valueCode` (object)
    An extension object type #Element.

  - `extension.valueDate` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01"

  - `extension._valueDate` (object)
    An extension object type #Element.

  - `extension.valueDateTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueDateTime` (object)
    An extension object type #Element.

  - `extension.valueDecimal` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1.23

  - `extension._valueDecimal` (object)
    An extension object type #Element.

  - `extension.valueId` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-id"

  - `extension._valueId` (object)
    An extension object type #Element.

  - `extension.valueInstant` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueInstant` (object)
    An extension object type #Element.

  - `extension.valueInteger` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valueInteger` (object)
    An extension object type #Element.

  - `extension.valueMarkdown` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "Sample markdown text"

  - `extension._valueMarkdown` (object)
    An extension object type #Element.

  - `extension.valueOid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:oid:1.2.3.4.5"

  - `extension._valueOid` (object)
    An extension object type #Element.

  - `extension.valuePositiveInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valuePositiveInt` (object)
    An extension object type #Element.

  - `extension.valueString` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-string"

  - `extension._valueString` (object)
    An extension object type #Element.

  - `extension.valueTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "12:00:00"

  - `extension._valueTime` (object)
    An extension object type #Element.

  - `extension.valueUnsignedInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).

  - `extension._valueUnsignedInt` (object)
    An extension object type #Element.

  - `extension.valueUri` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org/resource"

  - `extension._valueUri` (object)
    An extension object type #Element.

  - `extension.valueUrl` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org"

  - `extension._valueUrl` (object)
    An extension object type #Element.

  - `extension.valueUuid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"

  - `extension._valueUuid` (object)
    An extension object type #Element.

  - `extension.valueAddress` (object)
    An extension object type #Address.

  - `extension.valueAge` (object)
    An extension object type #Age.

  - `extension.valueAnnotation` (object)
    An extension object type #Annotation.

  - `extension.valueAttachment` (object)
    An extension object type #Attachment.

  - `extension.valueCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `extension.valueCoding` (object)
    An extension object type #Coding.

  - `extension.valueContactPoint` (object)
    An extension object type #ContactPoint.

  - `extension.valueCount` (object)
    An extension object type #Count.

  - `extension.valueDistance` (object)
    An extension object type #Distance.

  - `extension.valueDuration` (object)
    An extension object type #Duration.

  - `extension.valueHumanName` (object)
    An extension object type #HumanName.

  - `extension.valueIdentifier` (object)
    An extension object type #Identifier.

  - `extension.valueMoney` (object)
    An extension object type #Money.

  - `extension.valuePeriod` (object)
    An extension object type #Period.

  - `extension.valueQuantity` (object)
    An extension object type #Quantity.

  - `extension.valueRange` (object)
    An extension object type #Range.

  - `extension.valueRatio` (object)
    An extension object type #Ratio.

  - `extension.valueReference` (object)
    An extension object type #Reference.

  - `extension.valueSampledData` (object)
    An extension object type #SampledData.

  - `extension.valueSignature` (object)
    An extension object type #Signature.

  - `extension.valueTiming` (object)
    An extension object type #Timing.

  - `extension.valueContactDetail` (object)
    An extension object type #ContactDetail.

  - `extension.valueContributor` (object)
    An extension object type #Contributor.

  - `extension.valueDataRequirement` (object)
    An extension object type #DataRequirement.

  - `extension.valueExpression` (object)
    An extension object type #Expression.

  - `extension.valueParameterDefinition` (object)
    An extension object type #ParameterDefinition.

  - `extension.valueRelatedArtifact` (object)
    An extension object type #RelatedArtifact.

  - `extension.valueTriggerDefinition` (object)
    An extension object type #TriggerDefinition.

  - `extension.valueUsageContext` (object)
    An extension object type #UsageContext.

  - `extension.valueDosage` (object)
    An extension object type #Dosage.

  - `extension.valueMeta` (object)
    An extension object type #Meta.

  - `modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `identifier` (array)
    An identifier for this patient.
    Example: [{"use":"usual","type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"MR"}]},"system":"urn:oid:1.2.36.146.595.217.0.1","value":"12345","period":{"start":"2001-05-06"},"assigner":{"display":"Acme Healthcare"}}]

  - `identifier.use` (any)
    The purpose of this identifier.
    Enum: "usual", "official", "temp", "secondary", "old"

  - `identifier._use` (object)
    An extension object type #Element.

  - `identifier.type` (object)
    An extension object type #CodeableConcept.

  - `identifier.system` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `identifier._system` (object)
    An extension object type #Element.

  - `identifier.value` (string)
    An extension object type #string.
    Example: "example-string"

  - `identifier._value` (object)
    An extension object type #Element.

  - `identifier.period` (object)
    An extension object type #Period.

  - `identifier.assigner` (object)
    An extension object type #Reference.

  - `active` (boolean)
    Value of "true" or "false"
    Example: true

  - `_active` (object)
    Base definition for all elements in a resource.

  - `name` (array)
    A name associated with the individual.
    Example: [{"use":"official","family":"Chalmers","given":["Peter","James"]},{"use":"usual","given":["Jim"]},{"use":"maiden","family":"Windsor","given":["Peter","James"],"period":{"end":"2002"}}]

  - `name.use` (any)
    Identifies the purpose for this name.
    Enum: "usual", "official", "temp", "nickname", "anonymous", "old", "maiden"

  - `name.text` (string)
    An extension object type #string.
    Example: "example-string"

  - `name._text` (object)
    An extension object type #Element.

  - `name.family` (string)
    An extension object type #string.
    Example: "example-string"

  - `name._family` (object)
    An extension object type #Element.

  - `name.given` (array)
    Given name.
    Example: ["example-string"]

  - `name._given` (array)
    Extensions for given

  - `name.prefix` (array)
    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
    Example: ["example-string"]

  - `name._prefix` (array)
    Extensions for prefix

  - `name.suffix` (array)
    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
    Example: ["example-string"]

  - `name._suffix` (array)
    Extensions for suffix

  - `telecom` (array)
    A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
    Example: [{"use":"home"},{"system":"phone","value":"(03) 5555 6473","use":"work","rank":1},{"system":"phone","value":"(03) 3410 5613","use":"mobile","rank":2},{"system":"phone","value":"(03) 5555 8834","use":"old","period":{"end":"2014"}}]

  - `telecom.system` (any)
    Telecommunications form for contact point - what communications system is required to make use of the contact.
    Enum: "phone", "fax", "email", "pager", "url", "sms", "other"

  - `telecom.use` (any)
    Identifies the purpose for the contact point.
    Enum: "home", "work", "temp", "old", "mobile"

  - `telecom.rank` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `telecom._rank` (object)
    An extension object type #Element.

  - `gender` (any)
    Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
    Enum: "male", "female", "other", "unknown"

  - `_gender` (object)
    Base definition for all elements in a resource.

  - `birthDate` (string)
    A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date.  Dates SHALL be valid dates.
    Example: "2024-01-01"

  - `_birthDate` (object)
    Base definition for all elements in a resource.

  - `deceasedBoolean` (boolean)
    Indicates if the individual is deceased or not.
    Example: true

  - `_deceasedBoolean` (object)
    Base definition for all elements in a resource.

  - `deceasedDateTime` (string)
    Indicates if the individual is deceased or not.
    Example: "example-string"

  - `_deceasedDateTime` (object)
    Base definition for all elements in a resource.

  - `address` (array)
    An address for the individual.
    Example: [{"use":"home","type":"both","text":"534 Erewhon St PeasantVille, Rainbow, Vic  3999","line":["534 Erewhon St"],"city":"PleasantVille","district":"Rainbow","state":"Vic","postalCode":"3999","period":{"start":"1974-12-25"}}]

  - `address.use` (any)
    The purpose of this address.
    Enum: "home", "work", "temp", "old", "billing"

  - `address.type` (any)
    Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
    Enum: "postal", "physical", "both"

  - `address._type` (object)
    An extension object type #Element.

  - `address.line` (array)
    This component contains the house number, apartment number, street name, street direction,  P.O. Box number, delivery hints, and similar address information.
    Example: ["example-string"]

  - `address._line` (array)
    Extensions for line

  - `address.city` (string)
    An extension object type #string.
    Example: "example-string"

  - `address._city` (object)
    An extension object type #Element.

  - `address.district` (string)
    An extension object type #string.
    Example: "example-string"

  - `address._district` (object)
    An extension object type #Element.

  - `address.state` (string)
    An extension object type #string.
    Example: "example-string"

  - `address._state` (object)
    An extension object type #Element.

  - `address.postalCode` (string)
    An extension object type #string.
    Example: "example-string"

  - `address._postalCode` (object)
    An extension object type #Element.

  - `address.country` (string)
    An extension object type #string.
    Example: "example-string"

  - `address._country` (object)
    An extension object type #Element.

  - `maritalStatus` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `maritalStatus.coding` (array)
    A reference to a code defined by a terminology system.

  - `multipleBirthBoolean` (boolean)
    Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
    Example: true

  - `_multipleBirthBoolean` (object)
    Base definition for all elements in a resource.

  - `multipleBirthInteger` (number)
    Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
    Example: 1

  - `_multipleBirthInteger` (object)
    Base definition for all elements in a resource.

  - `photo` (array)
    Image of the patient.

  - `photo.contentType` (string)
    An extension object type #code.
    Example: "sample-code"

  - `photo._contentType` (object)
    An extension object type #Element.

  - `photo.language` (string)
    An extension object type #code.
    Example: "sample-code"

  - `photo._language` (object)
    An extension object type #Element.

  - `photo.data` (string)
    An extension object type #base64Binary.
    Example: "U2FtcGxl"

  - `photo._data` (object)
    An extension object type #Element.

  - `photo.url` (string)
    An extension object type #url.
    Example: "https://example.org"

  - `photo.size` (integer)
    An extension object type #unsignedInt.

  - `photo._size` (object)
    An extension object type #Element.

  - `photo.hash` (string)
    An extension object type #base64Binary.
    Example: "U2FtcGxl"

  - `photo._hash` (object)
    An extension object type #Element.

  - `photo.title` (string)
    An extension object type #string.
    Example: "example-string"

  - `photo._title` (object)
    An extension object type #Element.

  - `photo.creation` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `photo._creation` (object)
    An extension object type #Element.

  - `contact` (array)
    A contact party (e.g. guardian, partner, friend) for the patient.
    Example: [{"relationship":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0131","code":"N"}]}],"name":{"family":"du Marché","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-prefix","valueString":"VV"}]},"given":["Bénédicte"]},"telecom":[{"system":"phone","value":"+33 (237) 998327"}],"address":{"use":"home","type":"both","line":["534 Erewhon St"],"city":"PleasantVille","district":"Rainbow","state":"Vic","postalCode":"3999","period":{"start":"1974-12-25"}},"gender":"female","period":{"start":"2012"}}]

  - `contact.modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `contact.relationship` (array)
    The nature of the relationship between the patient and the contact person.

  - `contact.name` (object)
    An extension object type #HumanName.

  - `contact.telecom` (array)
    A contact detail for the person, e.g. a telephone number or an email address.

  - `contact.address` (object)
    An extension object type #Address.

  - `contact.gender` (any)
    Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
    Enum: "male", "female", "other", "unknown"

  - `contact._gender` (object)
    An extension object type #Element.

  - `contact.organization` (object)
    An extension object type #Reference.

  - `communication` (array)
    A language which may be used to communicate with the patient about his or her health.

  - `communication.language` (object, required)
    An extension object type #CodeableConcept.

  - `communication.preferred` (boolean)
    An extension object type #boolean.
    Example: true

  - `communication._preferred` (object)
    An extension object type #Element.

  - `generalPractitioner` (array)
    Patient's nominated care provider.

  - `generalPractitioner.reference` (string)
    An extension object type #string.
    Example: "example-string"

  - `generalPractitioner._reference` (object)
    An extension object type #Element.

  - `generalPractitioner.type` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `generalPractitioner.identifier` (object)
    An extension object type #Identifier.

  - `generalPractitioner.display` (string)
    An extension object type #string.
    Example: "example-string"

  - `generalPractitioner._display` (object)
    An extension object type #Element.

  - `managingOrganization` (object)
    A reference from one resource to another.

  - `link` (array)
    Link to another patient resource that concerns the same actual patient.

  - `link.other` (object, required)
    An extension object type #Reference.

  - `link.type` (any)
    The type of link between this patient resource and another patient resource.
    Enum: "replaced-by", "replaces", "refer", "seealso"

## Response 200 fields (application/json):

  - `resourceType` (any, required)
    This is a Patient resource
    Enum: "Patient"

  - `id` (string)
    Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive.
    Example: "example-id"

  - `meta` (object)
    The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

  - `meta.id` (string)
    An extension object type #string.
    Example: "example-string"

  - `meta.extension` (array)
    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `meta.versionId` (object)
    An extension object type #id.

  - `meta._versionId` (object)
    An extension object type #Element.

  - `meta.lastUpdated` (object)
    An extension object type #instant.

  - `meta._lastUpdated` (object)
    An extension object type #Element.

  - `meta.source` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `meta._source` (object)
    An extension object type #Element.

  - `meta.profile` (array)
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
    Example: ["http://example.org/Profile"]

  - `meta.security` (array)
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

  - `meta.tag` (array)
    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

  - `implicitRules` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_implicitRules` (object)
    Base definition for all elements in a resource.

  - `language` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_language` (object)
    Base definition for all elements in a resource.

  - `text` (object)
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.

  - `text.status` (any)
    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    Enum: "generated", "extensions", "additional", "empty"

  - `text._status` (object)
    An extension object type #Element.

  - `text.div` (string, required)
    An extension object type #xhtml.
    Example: "<div>Example</div>"

  - `contained` (array)
    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

  - `extension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `extension.url` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `extension._url` (object)
    An extension object type #Element.

  - `extension.valueBase64Binary` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "U2FtcGxl"

  - `extension._valueBase64Binary` (object)
    An extension object type #Element.

  - `extension.valueBoolean` (boolean)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: true

  - `extension._valueBoolean` (object)
    An extension object type #Element.

  - `extension.valueCanonical` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "http://example.org/Profile"

  - `extension._valueCanonical` (object)
    An extension object type #Element.

  - `extension.valueCode` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "sample-code"

  - `extension._valueCode` (object)
    An extension object type #Element.

  - `extension.valueDate` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01"

  - `extension._valueDate` (object)
    An extension object type #Element.

  - `extension.valueDateTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueDateTime` (object)
    An extension object type #Element.

  - `extension.valueDecimal` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1.23

  - `extension._valueDecimal` (object)
    An extension object type #Element.

  - `extension.valueId` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-id"

  - `extension._valueId` (object)
    An extension object type #Element.

  - `extension.valueInstant` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueInstant` (object)
    An extension object type #Element.

  - `extension.valueInteger` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valueInteger` (object)
    An extension object type #Element.

  - `extension.valueMarkdown` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "Sample markdown text"

  - `extension._valueMarkdown` (object)
    An extension object type #Element.

  - `extension.valueOid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:oid:1.2.3.4.5"

  - `extension._valueOid` (object)
    An extension object type #Element.

  - `extension.valuePositiveInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valuePositiveInt` (object)
    An extension object type #Element.

  - `extension.valueString` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-string"

  - `extension._valueString` (object)
    An extension object type #Element.

  - `extension.valueTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "12:00:00"

  - `extension._valueTime` (object)
    An extension object type #Element.

  - `extension.valueUnsignedInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).

  - `extension._valueUnsignedInt` (object)
    An extension object type #Element.

  - `extension.valueUri` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org/resource"

  - `extension._valueUri` (object)
    An extension object type #Element.

  - `extension.valueUrl` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org"

  - `extension._valueUrl` (object)
    An extension object type #Element.

  - `extension.valueUuid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"

  - `extension._valueUuid` (object)
    An extension object type #Element.

  - `extension.valueAddress` (object)
    An extension object type #Address.

  - `extension.valueAge` (object)
    An extension object type #Age.

  - `extension.valueAnnotation` (object)
    An extension object type #Annotation.

  - `extension.valueAttachment` (object)
    An extension object type #Attachment.

  - `extension.valueCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `extension.valueCoding` (object)
    An extension object type #Coding.

  - `extension.valueContactPoint` (object)
    An extension object type #ContactPoint.

  - `extension.valueCount` (object)
    An extension object type #Count.

  - `extension.valueDistance` (object)
    An extension object type #Distance.

  - `extension.valueDuration` (object)
    An extension object type #Duration.

  - `extension.valueHumanName` (object)
    An extension object type #HumanName.

  - `extension.valueIdentifier` (object)
    An extension object type #Identifier.

  - `extension.valueMoney` (object)
    An extension object type #Money.

  - `extension.valuePeriod` (object)
    An extension object type #Period.

  - `extension.valueQuantity` (object)
    An extension object type #Quantity.

  - `extension.valueRange` (object)
    An extension object type #Range.

  - `extension.valueRatio` (object)
    An extension object type #Ratio.

  - `extension.valueReference` (object)
    An extension object type #Reference.

  - `extension.valueSampledData` (object)
    An extension object type #SampledData.

  - `extension.valueSignature` (object)
    An extension object type #Signature.

  - `extension.valueTiming` (object)
    An extension object type #Timing.

  - `extension.valueContactDetail` (object)
    An extension object type #ContactDetail.

  - `extension.valueContributor` (object)
    An extension object type #Contributor.

  - `extension.valueDataRequirement` (object)
    An extension object type #DataRequirement.

  - `extension.valueExpression` (object)
    An extension object type #Expression.

  - `extension.valueParameterDefinition` (object)
    An extension object type #ParameterDefinition.

  - `extension.valueRelatedArtifact` (object)
    An extension object type #RelatedArtifact.

  - `extension.valueTriggerDefinition` (object)
    An extension object type #TriggerDefinition.

  - `extension.valueUsageContext` (object)
    An extension object type #UsageContext.

  - `extension.valueDosage` (object)
    An extension object type #Dosage.

  - `extension.valueMeta` (object)
    An extension object type #Meta.

  - `modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `identifier` (array)
    An identifier for this patient.
    Example: [{"use":"usual","type":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"MR"}]},"system":"urn:oid:1.2.36.146.595.217.0.1","value":"12345","period":{"start":"2001-05-06"},"assigner":{"display":"Acme Healthcare"}}]

  - `identifier.use` (any)
    The purpose of this identifier.
    Enum: "usual", "official", "temp", "secondary", "old"

  - `identifier._use` (object)
    An extension object type #Element.

  - `identifier.type` (object)
    An extension object type #CodeableConcept.

  - `identifier.system` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `identifier._system` (object)
    An extension object type #Element.

  - `identifier.value` (string)
    An extension object type #string.
    Example: "example-string"

  - `identifier._value` (object)
    An extension object type #Element.

  - `identifier.period` (object)
    An extension object type #Period.

  - `identifier.assigner` (object)
    An extension object type #Reference.

  - `active` (boolean)
    Value of "true" or "false"
    Example: true

  - `_active` (object)
    Base definition for all elements in a resource.

  - `name` (array)
    A name associated with the individual.
    Example: [{"use":"official","family":"Chalmers","given":["Peter","James"]},{"use":"usual","given":["Jim"]},{"use":"maiden","family":"Windsor","given":["Peter","James"],"period":{"end":"2002"}}]

  - `name.use` (any)
    Identifies the purpose for this name.
    Enum: "usual", "official", "temp", "nickname", "anonymous", "old", "maiden"

  - `name.text` (string)
    An extension object type #string.
    Example: "example-string"

  - `name._text` (object)
    An extension object type #Element.

  - `name.family` (string)
    An extension object type #string.
    Example: "example-string"

  - `name._family` (object)
    An extension object type #Element.

  - `name.given` (array)
    Given name.
    Example: ["example-string"]

  - `name._given` (array)
    Extensions for given

  - `name.prefix` (array)
    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
    Example: ["example-string"]

  - `name._prefix` (array)
    Extensions for prefix

  - `name.suffix` (array)
    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
    Example: ["example-string"]

  - `name._suffix` (array)
    Extensions for suffix

  - `telecom` (array)
    A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
    Example: [{"use":"home"},{"system":"phone","value":"(03) 5555 6473","use":"work","rank":1},{"system":"phone","value":"(03) 3410 5613","use":"mobile","rank":2},{"system":"phone","value":"(03) 5555 8834","use":"old","period":{"end":"2014"}}]

  - `telecom.system` (any)
    Telecommunications form for contact point - what communications system is required to make use of the contact.
    Enum: "phone", "fax", "email", "pager", "url", "sms", "other"

  - `telecom.use` (any)
    Identifies the purpose for the contact point.
    Enum: "home", "work", "temp", "old", "mobile"

  - `telecom.rank` (integer)
    An extension object type #positiveInt.
    Example: 1

  - `telecom._rank` (object)
    An extension object type #Element.

  - `gender` (any)
    Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
    Enum: "male", "female", "other", "unknown"

  - `_gender` (object)
    Base definition for all elements in a resource.

  - `birthDate` (string)
    A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date.  Dates SHALL be valid dates.
    Example: "2024-01-01"

  - `_birthDate` (object)
    Base definition for all elements in a resource.

  - `deceasedBoolean` (boolean)
    Indicates if the individual is deceased or not.
    Example: true

  - `_deceasedBoolean` (object)
    Base definition for all elements in a resource.

  - `deceasedDateTime` (string)
    Indicates if the individual is deceased or not.
    Example: "example-string"

  - `_deceasedDateTime` (object)
    Base definition for all elements in a resource.

  - `address` (array)
    An address for the individual.
    Example: [{"use":"home","type":"both","text":"534 Erewhon St PeasantVille, Rainbow, Vic  3999","line":["534 Erewhon St"],"city":"PleasantVille","district":"Rainbow","state":"Vic","postalCode":"3999","period":{"start":"1974-12-25"}}]

  - `address.use` (any)
    The purpose of this address.
    Enum: "home", "work", "temp", "old", "billing"

  - `address.type` (any)
    Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
    Enum: "postal", "physical", "both"

  - `address._type` (object)
    An extension object type #Element.

  - `address.line` (array)
    This component contains the house number, apartment number, street name, street direction,  P.O. Box number, delivery hints, and similar address information.
    Example: ["example-string"]

  - `address._line` (array)
    Extensions for line

  - `address.city` (string)
    An extension object type #string.
    Example: "example-string"

  - `address._city` (object)
    An extension object type #Element.

  - `address.district` (string)
    An extension object type #string.
    Example: "example-string"

  - `address._district` (object)
    An extension object type #Element.

  - `address.state` (string)
    An extension object type #string.
    Example: "example-string"

  - `address._state` (object)
    An extension object type #Element.

  - `address.postalCode` (string)
    An extension object type #string.
    Example: "example-string"

  - `address._postalCode` (object)
    An extension object type #Element.

  - `address.country` (string)
    An extension object type #string.
    Example: "example-string"

  - `address._country` (object)
    An extension object type #Element.

  - `maritalStatus` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `maritalStatus.coding` (array)
    A reference to a code defined by a terminology system.

  - `multipleBirthBoolean` (boolean)
    Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
    Example: true

  - `_multipleBirthBoolean` (object)
    Base definition for all elements in a resource.

  - `multipleBirthInteger` (number)
    Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
    Example: 1

  - `_multipleBirthInteger` (object)
    Base definition for all elements in a resource.

  - `photo` (array)
    Image of the patient.

  - `photo.contentType` (string)
    An extension object type #code.
    Example: "sample-code"

  - `photo._contentType` (object)
    An extension object type #Element.

  - `photo.language` (string)
    An extension object type #code.
    Example: "sample-code"

  - `photo._language` (object)
    An extension object type #Element.

  - `photo.data` (string)
    An extension object type #base64Binary.
    Example: "U2FtcGxl"

  - `photo._data` (object)
    An extension object type #Element.

  - `photo.url` (string)
    An extension object type #url.
    Example: "https://example.org"

  - `photo.size` (integer)
    An extension object type #unsignedInt.

  - `photo._size` (object)
    An extension object type #Element.

  - `photo.hash` (string)
    An extension object type #base64Binary.
    Example: "U2FtcGxl"

  - `photo._hash` (object)
    An extension object type #Element.

  - `photo.title` (string)
    An extension object type #string.
    Example: "example-string"

  - `photo._title` (object)
    An extension object type #Element.

  - `photo.creation` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `photo._creation` (object)
    An extension object type #Element.

  - `contact` (array)
    A contact party (e.g. guardian, partner, friend) for the patient.
    Example: [{"relationship":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0131","code":"N"}]}],"name":{"family":"du Marché","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-prefix","valueString":"VV"}]},"given":["Bénédicte"]},"telecom":[{"system":"phone","value":"+33 (237) 998327"}],"address":{"use":"home","type":"both","line":["534 Erewhon St"],"city":"PleasantVille","district":"Rainbow","state":"Vic","postalCode":"3999","period":{"start":"1974-12-25"}},"gender":"female","period":{"start":"2012"}}]

  - `contact.modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `contact.relationship` (array)
    The nature of the relationship between the patient and the contact person.

  - `contact.name` (object)
    An extension object type #HumanName.

  - `contact.telecom` (array)
    A contact detail for the person, e.g. a telephone number or an email address.

  - `contact.address` (object)
    An extension object type #Address.

  - `contact.gender` (any)
    Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
    Enum: "male", "female", "other", "unknown"

  - `contact._gender` (object)
    An extension object type #Element.

  - `contact.organization` (object)
    An extension object type #Reference.

  - `communication` (array)
    A language which may be used to communicate with the patient about his or her health.

  - `communication.language` (object, required)
    An extension object type #CodeableConcept.

  - `communication.preferred` (boolean)
    An extension object type #boolean.
    Example: true

  - `communication._preferred` (object)
    An extension object type #Element.

  - `generalPractitioner` (array)
    Patient's nominated care provider.

  - `generalPractitioner.reference` (string)
    An extension object type #string.
    Example: "example-string"

  - `generalPractitioner._reference` (object)
    An extension object type #Element.

  - `generalPractitioner.type` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `generalPractitioner.identifier` (object)
    An extension object type #Identifier.

  - `generalPractitioner.display` (string)
    An extension object type #string.
    Example: "example-string"

  - `generalPractitioner._display` (object)
    An extension object type #Element.

  - `managingOrganization` (object)
    A reference from one resource to another.

  - `link` (array)
    Link to another patient resource that concerns the same actual patient.

  - `link.other` (object, required)
    An extension object type #Reference.

  - `link.type` (any)
    The type of link between this patient resource and another patient resource.
    Enum: "replaced-by", "replaces", "refer", "seealso"

## Response 401 fields (application/json):

  - `message` (string, required)
    Error message indicating unauthorized access.
    Example: "Unauthorized"

  - `statusCode` (number, required)
    HTTP status code for unauthorized access.
    Example: 401


## Response 400 fields

## Response 404 fields